Codespaces Installation

GitHub Codespaces provides a complete, configurable development environment that runs in the cloud. For Frappe, it’s the fastest way to get started, as it handles all the setup for you automatically.

Prerequisites

• GitHub account

Step 1: Navigate to the Frappe Starter Repository

First, head over to the official Frappe starter repository on GitHub, which is pre-configured for Codespaces.

Step 2: Create the Codespace

1. Click the green < > Code button.
2. Select the Codespaces tab.
3. Click the Create codespace on main button to begin.

(Screenshot Placeholder 1) Add a screenshot here showing the GitHub page with the ‘Code’ button, ‘Codespaces’ tab, and ‘Create codespace’ button highlighted.

Step 3: Wait for the Environment to Build

GitHub will now build your cloud environment. This process is fully automated and involves:

• Setting up the virtual machine.
• Installing bench, Frappe’s command-line tool.
• Creating a new Frappe site.
• Installing the Frappe & ERPNext applications.

You can watch the progress in the built-in terminal. The initial setup can take several minutes.

(Screenshot Placeholder 2) Add a screenshot here of the VS Code interface in the browser, with the terminal visible showing the setup script running.

Step 4: Access Your Frappe Site

Once the setup is complete, the terminal will display a message indicating that your site is running. A pop-up will also appear in the bottom-right corner.

1. In the terminal output, locate the URL for your running application. It will look something like https://your-codespace-name-8000.preview.app.github.dev.
2. Ctrl + Click the link in the terminal to open your new Frappe site in a new browser tab.

(Screenshot Placeholder 3) Add a screenshot here of the terminal window after the setup is complete, highlighting the URL of the running Frappe site.

Step 5: Complete the Frappe Setup Wizard

Your Frappe site is now live! The first thing you’ll see is the Frappe setup wizard.

1. Choose your preferred language and timezone.
2. Create your Administrator user by providing your email, name, and a strong password. This will be the main login you use to access your site.

(Screenshot Placeholder 4) Add a screenshot here of the Frappe setup wizard welcome screen in the browser.

After completing the wizard, you will be logged into your new Frappe Desk. Congratulations, your Frappe environment is ready to use! 🎉

Managing Your Codespace Environment

Now that your environment is set up, here’s how to use and manage it.

Default Credentials

The starter template comes with pre-set credentials for system-level access. You likely won’t need these for normal development, but they are available if required.

• Frappe User: Administrator / admin
• MariaDB Root Password: 123

Accessing Your Codespace Later

You don’t need to create a new codespace every time. To resume your session:

1. Go to the GitHub Codespaces dashboard.
2. Click on your Frappe codespace to reopen it in your browser.

Using the Terminal

The VS Code interface includes a fully functional terminal. You can use it to run any bench command, just like on a local machine.

# Example: Create a new app
bench new-app custom-app