Skip to content

Commit 03de8da

Browse files
Phase 12: Update docs with Deployment and API features
1 parent 0f34a0a commit 03de8da

1 file changed

Lines changed: 32 additions & 0 deletions

File tree

README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,42 @@ Manage your entire project from one place:
3333
- `pythoncms run`: Start the dev server.
3434
- `pythoncms initialise`: Set up database and assets.
3535
- `pythoncms seed`: Reset default data.
36+
- `pythoncms deploy`: Generate production files (Dockerfile, docker-compose.yml).
3637
- `pythoncms --version`: Check your version.
3738

3839
---
3940

41+
## 🚀 Production Deployment
42+
43+
Deploying your CMS is now a single command:
44+
45+
```bash
46+
pythoncms deploy
47+
```
48+
49+
This generates a production-ready `Dockerfile` and `docker-compose.yml`. You can deploy this directly to:
50+
- **Fly.io**: `fly launch`
51+
- **Railway**: Connect your repo
52+
- **VPS**: `docker-compose up -d --build`
53+
54+
---
55+
56+
## 📡 REST API
57+
58+
Your content is automatically exposed via a JSON API.
59+
60+
**Endpoint:** `/api/v1/<content_type_name>`
61+
62+
### Pagination & Sorting
63+
- `?limit=10&offset=0`
64+
- `?sort_by=created_at&order=desc`
65+
66+
### Authentication (Optional)
67+
Set `API_TOKEN` in your `.env` to secure the API.
68+
Requests must then include header: `Authorization: Bearer <API_TOKEN>`
69+
70+
---
71+
4072
## ⚙️ Configuration
4173

4274
Your project settings are managed via the `.env` file in your root directory.

0 commit comments

Comments
 (0)