AI/firecrawl
1
0
Fork 0
mirror of https://git.mirrors.martin98.com/https://github.com/mendableai/firecrawl synced 2025-08-08 14:39:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1005 from RutamBhagat/contributing-md-docker-compose

Browse Source 
docs(CONTRIBUTING.md): Add Docker Compose setup instructions
This commit is contained in:
Nicolas 2024-12-23 13:38:20 -03:00 committed by GitHub
commit 51f79b55ef
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
CONTRIBUTING.md
View File

@ -111,6 +111,20 @@ curl -X POST http://localhost:3002/v1/crawl \
}'
```
### Alternative: Using Docker Compose
For a simpler setup, you can use Docker Compose to run all services:
1. Prerequisites: 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.
## Tests:
The best way to do this is run the test with `npm run test:local-no-auth` if you'd like to run the tests without authentication.