Skip to content

Update README with build command #1124

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
annavik wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README with build command #1124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,10 +144,14 @@ pip install -r requirements/local.txt

#### Helpful Commands

##### Run the docker compose stack in the background
##### Run the Docker compose stack in the background

docker compose up -d

##### Rebuild Docker images

docker compose build

##### Watch the logs of Django & the backend workers

docker compose logs -f django celeryworker
Expand Down Expand Up @@ -324,6 +328,7 @@ Antenna supports remote debugging with debugpy for both Django and Celery servic

### Troubleshooting

- **Problems after pull**: If Dockerfiles or dependencies have been updated, make sure to rebuild the Docker images: `docker compose build`. For source code changes, this is not needed.
- **Connection refused**: Make sure you copied `docker-compose.override-example.yml` to `docker-compose.override.yml`
- **Debugger not stopping**: Verify breakpoints are set in code that actually executes
- **Port conflicts**: Check that ports 5678 and 5679 aren't already in use on your host machine
Expand Down