Add initial project structure, including README, CONTRIBUTING, and documentation files
- Created .gitignore to exclude unnecessary files - Added README.md with project description and core features - Introduced CONTRIBUTING.md for development guidelines - Established documentation files for architecture, quality requirements, and technical risks
This commit is contained in:
@@ -0,0 +1,46 @@
|
||||
# Deployment View
|
||||
|
||||
## Infrastructure Overview
|
||||
|
||||
```txt
|
||||
┌─────────────┐ ┌──────────────────────────────────────┐
|
||||
│ Discord │◄─────►│ Coolify │
|
||||
│ Gateway │ WSS │ │
|
||||
│ + REST API │ │ ┌──────────────────────────────┐ │
|
||||
└─────────────┘ │ │ omo-bot (Node.js process) │ │
|
||||
│ │ - Command handlers │ │
|
||||
│ │ - Event listeners │ │
|
||||
│ │ - Mileage engine │ │
|
||||
│ └──────────┬───────────────────┘ │
|
||||
│ │ │
|
||||
│ ▼ │
|
||||
│ ┌──────────────────────────────┐ │
|
||||
│ │ PostgreSQL (local) │ │
|
||||
│ │ - User profiles │ │
|
||||
│ │ - Mileage scores │ │
|
||||
│ │ - Event schedules │ │
|
||||
│ │ - Content cache │ │
|
||||
│ └──────────────────────────────┘ │
|
||||
│ │
|
||||
│ ┌──────────────────────────────┐ │
|
||||
│ │ Admin API / Dashboard │ │
|
||||
│ │ (React SPA) │ │
|
||||
│ │ admin.openmicodyssey.com │ │
|
||||
│ └──────────────────────────────┘ │
|
||||
└──────────────────────────────────────┘
|
||||
│
|
||||
OAuth2 │
|
||||
▼
|
||||
┌─────────────────────┐
|
||||
│ openmicodyssey.com │
|
||||
│ (Web Application) │
|
||||
└─────────────────────┘
|
||||
```
|
||||
|
||||
## Environments
|
||||
|
||||
| Environment | Host | Bot Instance | DB | Purpose |
|
||||
| ----------- | ---------------- | ------------ | ---------------- | ---------------------------- | ---------------------- |
|
||||
| Development | Local machine | 1 process | Local Postgres | Feature development, testing |
|
||||
| Staging | Coolify | 1 instance | Staging Postgres | Integration | Pre-release validation |
|
||||
| Production | Coolify (scaled) | 2+ instances | Production (HA) | Live community server |
|
||||
Reference in New Issue
Block a user