Skip to content

Commit 6d03396

Browse files
Merge pull request #16 from mdhishaamakhtar/master
2 parents 08fac01 + eafa45a commit 6d03396

2 files changed

Lines changed: 4 additions & 18 deletions

File tree

API_DOCUMENTATION.md

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -74,38 +74,25 @@ celery -A celery_worker.celery worker --loglevel=info --queues=celery,pathfindin
7474

7575
### 4. Using with Process Managers
7676

77-
The application includes two Procfile options:
77+
The application includes a Procfile
7878

79-
**Option 1: Separate Processes (Default - Procfile)**
80-
```
81-
web: gunicorn --bind 0.0.0.0:9020 run:app
82-
worker: celery -A celery_worker.celery worker --loglevel=info
83-
```
84-
85-
**Option 2: Single Process (Procfile.single)**
79+
**Procfile:**
8680
```
8781
web: ./start.sh
8882
```
8983

90-
Usage:
84+
**Usage:**
9185
```bash
92-
# Using separate processes (recommended for production platforms)
86+
# For production
9387
foreman start
9488

95-
# Using single process
96-
foreman start -f Procfile.single
97-
9889
# Using Heroku (automatically uses Procfile)
9990
git push heroku main
10091

10192
# Using honcho
10293
honcho start
10394
```
10495

105-
**When to use which:**
106-
- **Separate processes**: Better for production platforms (Heroku, etc.) that can scale web/worker independently
107-
- **Single process**: Better for simple deployments or local development with process managers
108-
10996
## API Endpoints
11097

11198
### 1. Root Endpoint - API Information

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,6 @@ The project demonstrates expertise in:
4545
### ✅ Development Tools
4646
- **Comprehensive Testing**: Unit and integration tests with 100% pass rate
4747
- **Environment Management**: Separate configurations for development, testing, and production
48-
- **Docker Support**: Containerization for consistent deployments
4948
- **CI/CD Ready**: GitHub Actions integration for automated testing and deployment
5049

5150
## Quick Start

0 commit comments

Comments
 (0)