Setup of the development environment
Prerequisites
-
A running Docker instance (or other compatible container engine)
-
Visual Studio Code (VS Code) with the Remote Development Extension Pack installed
-
Know how to work with devcontainers (optional)
Installing Docker on Windows is sometimes a struggle. Recommended Approach: Follow the installation instructions for Docker Desktop. Installing Docker on Linux or Mac should be straight forward.
Get the source code and editor ready
-
Clone the gif-next repository to your local machine
-
Open the repository in VS Code
There are different ways to work with the repository (described below)
-
Use the devcontainer provided in the repository
-
Use Github Codespaces
Start the devcontainer
-
Start the devcontainer (either wait for the pop to build the devcontainer or open the command list (F1) and select the command Dev Containers: Rebuild and reopen in container)
-
Wait for the devcontainer to finish setup
-
The devcontainer setup includes a second container with an anvil instance that is started automatically. This can be used for local development and testing where persistence is not bound by the lifecycle of the deployment process.
Use Github Codespaces
Github Codespaces is a new feature of Github that allows you to work with a repository in a container environment hosted by Github.
To use Github Codespaces you need to have a Github account and you need to be logged in to Github.
Open the gif-next repository in your browser and click on the button Code and select Open with Codespaces from the dropdown menu.
This will open a new browser tab with the sandbox repository in a devcontainer hosted by Github.
You can now work with the sandbox repository in the browser (or open the codespace in VS Code by clicking on the button Open with VS Code in the upper right corner of the browser tab).
To improve performance of the codespace you can change the machine type in the codespace settings.