Initial commit: Complete project-bootstrap tool
- Bootstrap script for creating monorepo projects - FastAPI backend templates with uv, ruff, mypy, pytest - React frontend templates with TypeScript, ESLint, Prettier - Docker Compose setup with backend, frontend, and database - 9 development and CI scripts - Gitea Actions CI/CD workflows - Comprehensive documentation (8 files) - 45 template files for complete project structure - Automated verification script (all tests pass) - Based on coding-agent-rules standards
This commit is contained in:
71
templates/deploy/README.md
Normal file
71
templates/deploy/README.md
Normal file
@@ -0,0 +1,71 @@
|
||||
# Deployment Configuration
|
||||
|
||||
This directory contains deployment artifacts for the project.
|
||||
|
||||
## Structure
|
||||
|
||||
- **compose.yml** - Docker Compose configuration for local development and deployment
|
||||
- **.env.example** - Example environment variables
|
||||
- **docker/** - Dockerfiles and container documentation
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Local Development
|
||||
|
||||
1. Copy environment file:
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
2. Start all services:
|
||||
```bash
|
||||
docker compose -f deploy/compose.yml up
|
||||
```
|
||||
|
||||
3. Access services:
|
||||
- Backend: http://localhost:8000
|
||||
- Frontend: http://localhost:3000
|
||||
- API Docs: http://localhost:8000/docs
|
||||
- Database: localhost:5432
|
||||
|
||||
### Stop Services
|
||||
|
||||
```bash
|
||||
docker compose -f deploy/compose.yml down
|
||||
```
|
||||
|
||||
### Rebuild Services
|
||||
|
||||
```bash
|
||||
docker compose -f deploy/compose.yml up --build
|
||||
```
|
||||
|
||||
### View Logs
|
||||
|
||||
```bash
|
||||
# All services
|
||||
docker compose -f deploy/compose.yml logs -f
|
||||
|
||||
# Specific service
|
||||
docker compose -f deploy/compose.yml logs -f backend
|
||||
```
|
||||
|
||||
## Production Deployment
|
||||
|
||||
For production deployments, consider:
|
||||
|
||||
1. Using separate compose files for different environments
|
||||
2. Implementing proper secret management
|
||||
3. Setting up reverse proxy (nginx/traefik)
|
||||
4. Configuring SSL/TLS certificates
|
||||
5. Setting up monitoring and logging
|
||||
6. Implementing backup strategies
|
||||
|
||||
## Kubernetes (Optional)
|
||||
|
||||
If deploying to Kubernetes, create a `k8s/` directory with:
|
||||
|
||||
- Deployment manifests
|
||||
- Service definitions
|
||||
- ConfigMaps and Secrets
|
||||
- Ingress configuration
|
||||
Reference in New Issue
Block a user