mirror of
https://github.com/thecyberlearn/quantum-ai-v3.git
synced 2026-08-18 12:52:58 +00:00
📚 Update documentation with deployment and health check information
- Add comprehensive Railway.app deployment section to CLAUDE.md - Document health check endpoint (/health/) for monitoring - Include production commands and health monitoring examples - Update URL structure to include /health/ and /contact/ endpoints - Reference new deployment guides (RAILWAY_DEPLOYMENT_GUIDE.md, etc.) - Add production features documentation (PostgreSQL, Redis, SSL) Documentation now includes: • Complete deployment workflow with Railway.app • Health monitoring and production commands • Environment configuration and verification steps • Updated URL structure with new endpoints 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
parent
b429f7c7ef
commit
c5d87ccbaa
50
CLAUDE.md
50
CLAUDE.md
@ -53,6 +53,9 @@ python tests/test_five_whys_webhook.py
|
|||||||
|
|
||||||
# Test homepage functionality
|
# Test homepage functionality
|
||||||
python tests/test_homepage.py
|
python tests/test_homepage.py
|
||||||
|
|
||||||
|
# Test health check endpoint
|
||||||
|
curl http://localhost:8000/health/
|
||||||
```
|
```
|
||||||
|
|
||||||
### Custom Management Commands
|
### Custom Management Commands
|
||||||
@ -129,6 +132,8 @@ Each agent is a separate Django app following this structure:
|
|||||||
```
|
```
|
||||||
/ # Homepage (core app)
|
/ # Homepage (core app)
|
||||||
/pricing/ # Pricing page (core app)
|
/pricing/ # Pricing page (core app)
|
||||||
|
/health/ # Health check endpoint for monitoring (core app)
|
||||||
|
/contact/ # Contact form submission (core app)
|
||||||
/marketplace/ # Agent marketplace (agent_base app)
|
/marketplace/ # Agent marketplace (agent_base app)
|
||||||
/agents/<slug>/ # Agent detail redirect (agent_base app)
|
/agents/<slug>/ # Agent detail redirect (agent_base app)
|
||||||
/auth/ # Authentication (login, register, profile)
|
/auth/ # Authentication (login, register, profile)
|
||||||
@ -299,12 +304,51 @@ This ensures Claude will:
|
|||||||
✅ Follow established patterns from working agents
|
✅ Follow established patterns from working agents
|
||||||
✅ Maintain consistency across the platform
|
✅ Maintain consistency across the platform
|
||||||
|
|
||||||
### Deployment
|
### Deployment & Production
|
||||||
|
|
||||||
- **Railway.app** integration via `railway.json`
|
**Railway.app (Recommended)**
|
||||||
- Production settings in `netcop_hub/production_settings.py`
|
- **Configuration**: `railway.json` with optimized Gunicorn settings
|
||||||
|
- **Deployment Guide**: See `RAILWAY_DEPLOYMENT_GUIDE.md` for step-by-step instructions
|
||||||
|
- **Environment Variables**: Use `RAILWAY_ENV_TEMPLATE.md` for production configuration
|
||||||
|
- **Health Check**: `/health/` endpoint for monitoring and load balancers
|
||||||
|
- **Verification**: Follow `POST_DEPLOYMENT_CHECKLIST.md` after deployment
|
||||||
|
|
||||||
|
**Production Features:**
|
||||||
|
- PostgreSQL database with connection pooling
|
||||||
|
- Redis caching for sessions and performance
|
||||||
|
- SSL certificates and HTTPS enforcement
|
||||||
- Static files served via WhiteNoise
|
- Static files served via WhiteNoise
|
||||||
- Database migrations run automatically on deployment
|
- Database migrations run automatically on deployment
|
||||||
|
- Rate limiting and security headers
|
||||||
|
- Custom 404/500 error pages
|
||||||
|
|
||||||
|
**Health Monitoring:**
|
||||||
|
```bash
|
||||||
|
# Check application health
|
||||||
|
curl https://your-domain.railway.app/health/
|
||||||
|
|
||||||
|
# Expected response:
|
||||||
|
{
|
||||||
|
"status": "healthy",
|
||||||
|
"checks": {
|
||||||
|
"database": {"status": "healthy", "response_time_ms": 2.5},
|
||||||
|
"agents": {"status": "healthy", "active_count": 7}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
**Production Commands:**
|
||||||
|
```bash
|
||||||
|
# Test deployment readiness
|
||||||
|
DEBUG=False python manage.py check --deploy
|
||||||
|
|
||||||
|
# Collect static files for production
|
||||||
|
python manage.py collectstatic --noinput
|
||||||
|
|
||||||
|
# Test health check locally
|
||||||
|
python manage.py runserver
|
||||||
|
curl http://localhost:8000/health/
|
||||||
|
```
|
||||||
|
|
||||||
### File Upload Handling
|
### File Upload Handling
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user