mac-docker.md

← Back: Getting started

Installing on MacOS (Docker)

Requirements

• Homebrew
• colima or Docker Desktop
  • colima can be more performant than Docker Desktop, but is less easy to use

Installing

First clone the Samfundet4 repository.

git clone [email protected]:Samfundet/Samfundet4.git

If you use colima, run colima start to start the engine.

Environment files

Both the frontend and backend directories contain a .docker.example.env file. Copy these files to .docker.env and adjust any values as needed. You may for example want to change the default Django superuser username and password (DJANGO_SUPERUSER_USERNAME and DJANGO_SUPERUSER_USERNAME).

Building

This builds all the Samfundet4 containers:

cd Samfundet4
docker compose build

# You can also choose to build only specific containers if you want:
docker compose build frontend backend

Running

This will start the backend and frontend containers:

docker compose up backend frontend

Dependency issues?

Editors/IDEs typically don't have access to installed dependencies which lie inside Docker containers. This means you may have to install dependencies locally too, in order for your editor/IDE to resolve them. See the Editor configuration guide for more information.

Post-install

Now that you've got the project up and running, check out the post-install instructions:

→ Next: Post-install