Skip to content
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.

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

[Self-Host] (documentation) CONTRIBUTING.md lacks documentation for using Docker Compose #1004

Open
RutamBhagat opened this issue Dec 21, 2024 · 0 comments · May be fixed by #1005
Open

[Self-Host] (documentation) CONTRIBUTING.md lacks documentation for using Docker Compose #1004

RutamBhagat opened this issue Dec 21, 2024 · 0 comments · May be fixed by #1005

Comments

@RutamBhagat
Copy link

Describe the Issue
The current CONTRIBUTING.md lacks documentation for using Docker Compose as a simpler alternative to run the project locally. While the current manual setup is helpful, we should add Docker Compose instructions since it's already supported via docker-compose.yaml.

Proposed Changes
Add a new section to CONTRIBUTING.md after the existing manual setup instructions:

### Alternative: Using Docker Compose

For a simpler setup, you can use Docker Compose to run all services with a single command:

1. Make sure you have Docker and Docker Compose installed
2. Copy the `.env.example` file to `.env` in the `/apps/api/` directory and configure as needed
3. From the root directory, run:

 ```bash
 docker compose up
 ```

This will start Redis, the API server, and workers automatically in the correct configuration.

You can then test the API just as described above:

Why This Change Matters

  • Simpler developer onboarding
  • Consistent environment across all developers
  • No need to manage multiple terminal windows
  • Reduces potential configuration issues

Additional Context
This change doesn't remove the existing manual setup instructions, but adds Docker Compose as an alternative option that some developers may prefer.

Related Files

  • CONTRIBUTING.md
  • docker-compose.yaml
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant