Setup Develop Environment (Codespace)

Setup your development environment with GitHub Codespace.

To save time and quickly build the development environment, we provide another version of the development environment configuration, that’s GitHub Codespace.

Configuration Tutorial

1. Create Codespaces

   Click the following button to create a cloud codespaces for server-pro development.

   

   It’s more recommented to choose Machine Type at least 4-core. For larger machine type, you can make a request to GitHub’s official support team by filing a ticket here.

   
2. Launch Setup Script

   You will need to wait patiently before the codespace get created. After you can have access to your Terminal, run the folloing command:

   cd develop/
   bin/setup
   

   

   This script (bin/setup) allows you to set up the development environment on the latest commit of the server-pro branch in the shortest possible time. It may not be applicable to older versions/other branches.

   We build development docker image every day with GitHub Action.

3. Access Your Launchpad

   Switch to port tab, you will see a list of avaiable web port. Click the one with 80. You should see launchpad page now.

   

   You will see:

   
4. Enjoy Development

   Now, time to your own time! Start build your awesome feature. You need to run the following command to enable realtime display:

   bash

   docker compose -f docker-compose.yml -f docker-compose.dev.yml -f ./docker-compose.image.yml up --no-deps --detach