chamomind/elearning
7
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages 3 Wiki Activity Actions

feat: Add initial Docker setup and development environment documentation.

Browse source
This commit is contained in:
supalerk-ar66 2026-02-05 11:01:17 +07:00
parent 42b7399868
commit ca65dbff4c
5 changed files with 124 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

74
docs/development_setup.md
View file

@ -43,27 +43,31 @@
## 📦 Services on Proxmox Server
### 1. PostgreSQL - Database
- **Port**: 5432
- **Purpose**: Main application database
- **Access**: All developers
### 2. MinIO - S3-compatible Storage
- **Port**: 9000 (API), 9001 (Console)
- **Purpose**: File storage (videos, documents, images)
- **Access**: Backend + Developers
### 3. Mailhog - Email Testing
- **Port**: 1025 (SMTP), 8025 (Web UI)
- **Purpose**: Catch all emails in development
- **Access**: All developers
### 4. Adminer - Database Management
- **Port**: 8080
- **Purpose**: Web-based database management
- **Access**: All developers
### 5. Forgejo - Git Server
- **Port**: 3030 (HTTP), 2222 (SSH)
- **Purpose**: Self-hosted Git repository (like GitHub/GitLab)
- **Access**: All developers
@ -77,7 +81,7 @@ Create this file on your Proxmox server:
### `/opt/elearning-dev/docker-compose.yml`
```yaml
version: '3.8'
version: "3.8"
services:
# PostgreSQL Database
@ -109,8 +113,8 @@ services:
container_name: elearning-minio
restart: unless-stopped
ports:
- "9000:9000" # API
- "9001:9001" # Console
- "9000:9000" # API
- "9001:9001" # Console
environment:
MINIO_ROOT_USER: minioadmin
MINIO_ROOT_PASSWORD: minioadmin123
@ -148,15 +152,14 @@ services:
networks:
- elearning-network
# Mailhog - Email Testing
mailhog:
image: mailhog/mailhog:latest
container_name: elearning-mailhog
restart: unless-stopped
ports:
- "1025:1025" # SMTP
- "8025:8025" # Web UI
- "1025:1025" # SMTP
- "8025:8025" # Web UI
networks:
- elearning-network
@ -181,8 +184,8 @@ services:
container_name: elearning-forgejo
restart: unless-stopped
ports:
- "3030:3000" # HTTP
- "2222:22" # SSH
- "3030:3000" # HTTP
- "2222:22" # SSH
environment:
- USER_UID=1000
- USER_GID=1000
@ -288,21 +291,24 @@ curl http://192.168.1.100:9000/minio/health/live
**Directory**: `/path/to/frontend-student`
**`.env.local`**:
```env
# API Configuration
NEXT_PUBLIC_API_URL=http://localhost:4000/api
NUXT_PUBLIC_API_BASE=http://localhost:4000/api
NEXT_PUBLIC_WS_URL=ws://localhost:4000
# MinIO/S3 Configuration
NEXT_PUBLIC_S3_ENDPOINT=http://192.168.1.100:9000
NEXT_PUBLIC_S3_BUCKET=courses
NUXT_PUBLIC_S3_ENDPOINT=http://192.168.1.100:9000
NUXT_PUBLIC_S3_BUCKET=courses
# App Configuration
NEXT_PUBLIC_APP_NAME=E-Learning Platform
NEXT_PUBLIC_APP_URL=http://localhost:3000
NUXT_PUBLIC_APP_NAME=E-Learning Platform
NUXT_PUBLIC_APP_URL=http://localhost:3000
```
**Start Command**:
```bash
npm run dev
# or
@ -316,21 +322,24 @@ yarn dev
**Directory**: `/path/to/frontend-admin`
**`.env.local`**:
```env
# API Configuration
NEXT_PUBLIC_API_URL=http://localhost:4000/api
NUXT_PUBLIC_API_BASE=http://localhost:4000/api
NEXT_PUBLIC_WS_URL=ws://localhost:4000
# MinIO/S3 Configuration
NEXT_PUBLIC_S3_ENDPOINT=http://192.168.1.100:9000
NEXT_PUBLIC_S3_BUCKET=courses
NUXT_PUBLIC_S3_ENDPOINT=http://192.168.1.100:9000
NUXT_PUBLIC_S3_BUCKET=courses
# App Configuration
NEXT_PUBLIC_APP_NAME=E-Learning Admin
NEXT_PUBLIC_APP_URL=http://localhost:3001
NUXT_PUBLIC_APP_NAME=E-Learning Admin
NUXT_PUBLIC_APP_URL=http://localhost:3001
```
**package.json** (modify dev script):
```json
{
"scripts": {
@ -340,6 +349,7 @@ NEXT_PUBLIC_APP_URL=http://localhost:3001
```
**Start Command**:
```bash
npm run dev
# or
@ -353,6 +363,7 @@ yarn dev
**Directory**: `/path/to/backend`
**`.env`**:
```env
# Application
NODE_ENV=development
@ -404,6 +415,7 @@ ALLOWED_IMAGE_TYPES=image/jpeg,image/png,image/gif
```
**Start Command**:
```bash
npm run dev
# or
@ -463,14 +475,14 @@ docker exec -it elearning-minio mc ls local/
## 🌐 Access URLs
| Service | URL | Credentials |
|---------|-----|-------------|
| **Frontend (Student)** | http://localhost:3000 | - |
| **Frontend (Admin)** | http://localhost:3001 | - |
| **Backend API** | http://localhost:4000 | - |
| **PostgreSQL** | 192.168.1.100:5432 | elearning / dev_password_change_in_prod |
| **MinIO Console** | http://192.168.1.100:9001 | minioadmin / minioadmin123 |
| **MinIO API** | http://192.168.1.100:9000 | - |
| Service | URL | Credentials |
| ---------------------- | ------------------------- | --------------------------------------- |
| **Frontend (Student)** | http://localhost:3000 | - |
| **Frontend (Admin)** | http://localhost:3001 | - |
| **Backend API** | http://localhost:4000 | - |
| **PostgreSQL** | 192.168.1.100:5432 | elearning / dev_password_change_in_prod |
| **MinIO Console** | http://192.168.1.100:9001 | minioadmin / minioadmin123 |
| **MinIO API** | http://192.168.1.100:9000 | - |
| **Mailhog UI** | http://192.168.1.100:8025 | - |
| **Adminer** | http://192.168.1.100:8080 | - |
@ -482,12 +494,14 @@ docker exec -it elearning-minio mc ls local/
## 📊 Resource Requirements
### Proxmox Server (Recommended)
- **CPU**: 4 cores
- **RAM**: 8 GB
- **Storage**: 50 GB (SSD recommended)
- **Network**: 1 Gbps
### Developer Machines
- **CPU**: 2+ cores
- **RAM**: 8 GB
- **Storage**: 20 GB free space
@ -498,6 +512,7 @@ docker exec -it elearning-minio mc ls local/
> [!WARNING]
> **Development Environment Only!**
>
> - These credentials are for development only
> - Change all passwords in production
> - Never commit `.env` files to git
@ -561,6 +576,7 @@ docker-compose up -d
### Daily Workflow
1. **Start Proxmox Services** (if not running)
```bash
ssh root@192.168.1.100
cd /opt/elearning-dev
@ -568,18 +584,21 @@ docker-compose up -d
```
2. **Start Backend**
```bash
cd /path/to/backend
npm run dev
```
3. **Start Frontend (Student)**
```bash
cd /path/to/frontend-student
npm run dev
```
4. **Start Frontend (Admin)**
```bash
cd /path/to/frontend-admin
npm run dev
@ -618,4 +637,3 @@ docker-compose stop
- [Docker Compose Documentation](https://docs.docker.com/compose/)
- [PostgreSQL Documentation](https://www.postgresql.org/docs/)
- [MinIO Documentation](https://min.io/docs/)