Developer Setup

Easy mode: Development containers

We love development containers. They keep your development environment in a VM and isolated from the rest of your device which is good security practice. They also make it extremely easy to share editor configurations and development dependencies that can't be managed using language package managers.

Much as we hate to stan Microsoft, it's the easiest option to work on this library.

(you may be interested in trying out VSCodium, an opensource distribution of VSCode)

In Visual Studio Code

1. From the command palette select "Remote Containers: Clone Repository in Named Container Volume".
2. Enter: git@github.com:commonknowledge/groundwork.git.
3. Choose a development container to install to, or create a new one.
4. Wait for the container to initialize and the project bootstrap scripts to finish.

More information

• VSCode Development Containers

Hard mode: Do it yourself

1. Ensure that you have the following installed:
2. NodeJS
3. Yarn
4. Python 3.9+
5. Poetry
6. Follow the installation instructions for DjangoGIS's local dependencies.
7. Ensure that you have the DATABASE_URL environmental variable pointing to a local postgres database.
8. Clone the repository and run make bootstrap.