ab44954bd6
- Updated `.gitignore` to clarify environment variable handling. - Enhanced `pnpm-lock.yaml` with new dependencies for Jest and Supertest, including type definitions. - Improved bilingual documentation in `SKILL.md` files for better clarity on comment patterns and project rules. - Refined `docker-compose.yml` for local development, adding detailed instructions and access points. - Updated environment variable example in `env.local.example` for better guidance on configuration. - Removed outdated architecture documentation from the service template. - Enhanced Dockerfile for improved security and performance during builds. - Added Swagger documentation setup in the service template for better API documentation. - Improved error handling and logging middleware for enhanced debugging capabilities.
47 lines
1.2 KiB
Markdown
47 lines
1.2 KiB
Markdown
# Local Development Deployment
|
|
|
|
Docker Compose configuration for running the GoodGo platform locally.
|
|
|
|
## Quick Start
|
|
|
|
```bash
|
|
# Setup environment
|
|
cp env.local.example .env.local
|
|
|
|
# Start platform
|
|
docker-compose up -d
|
|
|
|
# View status
|
|
docker-compose ps
|
|
```
|
|
|
|
## Access
|
|
|
|
- **Traefik Dashboard**: http://localhost:8080
|
|
- **Auth Service**: http://localhost/api/v1/auth
|
|
- **Web Admin**: http://admin.localhost (currently disabled)
|
|
- **Web Client**: http://localhost (currently disabled)
|
|
|
|
## Documentation
|
|
|
|
For detailed documentation, see:
|
|
- **English**: [docs/en/guides/local-deployment.md](../../docs/en/guides/local-deployment.md)
|
|
- **Vietnamese**: [docs/vi/guides/local-deployment.md](../../docs/vi/guides/local-deployment.md)
|
|
|
|
## Files
|
|
|
|
- `docker-compose.yml` - Service orchestration
|
|
- `env.local.example` - Environment variables template
|
|
- `.env.local` - Your local environment (git-ignored)
|
|
|
|
## Common Commands
|
|
|
|
```bash
|
|
docker-compose up -d # Start all
|
|
docker-compose logs -f [service] # View logs
|
|
docker-compose down # Stop all
|
|
docker-compose ps # Check status
|
|
```
|
|
|
|
For troubleshooting and advanced usage, see the full documentation above.
|