This project is part of this guide: https://davidrios.dev/2020/11/01/docker-vscode.html.
You need a recent version of Docker and docker-compose.
Create a copy of .env.template
as .env
and change as
necessary. If you are using Linux, you'll at least need to
change the variable LOCAL_USER_ID
to the uid of your local
user, which can be queried executing id -u
at the terminal.
If you are using Windows, install WSL2 and a recent version of Docker Desktop. Clone the repository inside Ubuntu, not in the regular Windows disks, and run the commands at the Ubuntu terminal.
Run the project by executing:
$ docker-compose up --build
While the project is running, at another terminal:
If you have not configured the backend application yet, run
the script ./setup-backend.sh
once.
You can now access it at http://localhost:8000 and the Django admin at http://localhost:8000/admin, assuming you didn't change the APP_PORT env var.
You will need VS Code 1.50+ with these extensions:
Now to edit the frontend source, open the folder code/vscode/frontend
in VS Code and click Reopen in Container
when the notification
shows up. Under WSL2, you can navigate to \\wsl$\ubuntu ...\code\vscode\frontend
To edit the backend source, open the folder code/vscode/backend
in VS Code and click Reopen in Container
when the notification
shows up. Under WSL2, you can navigate to \\wsl$\ubuntu ...\code\vscode\backend
If you need more info, refer to the guide at the top of this readme.