priyanshuksharma/project-interns
Comprehensive inventory management system with role-based control, email alerts, and file support.
672
priyanshuksharma/project-interns repository overview
🐳 Docker Complete Guide
Marquardt India Pvt. Ltd. - Project Interns
🚀 One-click deployment • 🌐 Global access • ⚡ Production-ready
🎯 Quick Navigation
| 🚀 Quick Start | 🔍 Services | 🌐 Global Access |
|---|---|---|
| Get running in 30s | Understand the stack | Share with the world |
| ⚙️ Configuration | 📊 Monitoring | 🛠️ Troubleshooting |
|---|---|---|
| Env setup | Track & debug | Fix common issues |
⚡ Lightning Quick Start
Local Development Mode 🖥️
# 🚀 Launch app + database in one command
docker-compose --profile dev up -d
# ✅ Check containers
docker-compose ps
# 📋 View logs
docker-compose logs -f app
👉 App available at: http://localhost:3000
Global Access Mode 🌍 (Choose your option)
| Service | Difficulty | URL Type | Best For |
|---|---|---|---|
| 🆓 Serveo | ⭐ Beginner | Dynamic | Quick demos |
| 🎯 ngrok | ⭐⭐ Easy | Static | Development |
| ☁️ Cloudflare | ⭐⭐⭐ Pro | Permanent | Production |
# Example: Start with ngrok (Recommended)
docker-compose --profile dev --profile ngrok up -d
🏗️ Service Overview
┌─────────────┐ ┌─────────────┐ ┌─────────────┐
│ 📱 App │◄──► │ 🗄️ Database│◄──►│ 🌐 Tunnels │
│ Node.js │ │ MySQL │ │ Global URL │
│ Express │ │ 3307 │ │ Internet │
└─────────────┘ └─────────────┘ └─────────────┘
- Node.js App → Port 3000, hot reload, health checks
- MySQL DB → User:
sigma, Pass:sigma, Port 3307 - Adminer (DB UI) →
http://localhost:8080
🌐 Global Access Tunneling
🔗 Example Static URL (via ngrok): https://bright-pleasing-marlin.ngrok-free.app
🎮 Command Cheat Sheet
Local Development 🏠
docker-compose --profile dev up -d
Global Access 🌍
docker-compose --profile dev --profile ngrok up -d
Production Deployment 🏭
docker-compose --profile production up -d
Database Admin 🗄️
docker-compose --profile admin up -d
# Open http://localhost:8080
Stop Everything 🛑
docker-compose down -v
⚙️ Configuration Setup
.env Template
NODE_ENV=development
SESSION_SECRET=your-secret-key
DB_HOST=mysql
DB_USER=sigma
DB_PASSWORD=sigma
DB_NAME=product_management_system
DB_PORT=3306
NGROK_AUTHTOKEN=your_ngrok_token
NGROK_DOMAIN=bright-pleasing-marlin.ngrok-free.app
CLOUDFLARE_TUNNEL_TOKEN=your_cloudflare_token
📊 Monitoring & Debugging
Health Checks
docker-compose ps
docker-compose logs -f app
Useful URLs
- App Health →
http://localhost:3000/health - ngrok Dashboard →
http://localhost:4040 - DB Admin →
http://localhost:8080
🛠️ Troubleshooting Guide
| Problem | Quick Fix | |
|---|---|---|
| Port 3307 in use | `netstat -ano | findstr :3307` → kill process |
| App won’t start | docker logs project-interns | |
| DB connection fails | docker-compose restart mysql | |
| Tunnel not working | Restart ngrok/serveo/cloudflare |
🏗️ Architecture
Internet
│
▼
┌─────────────────────────────────────────────────────────┐
│ TUNNEL SERVICES │
├─────────────────┬─────────────────┬─────────────────────┤
│ Serveo.net │ ngrok │ Cloudflare │
│ (Free) │ (Static URL) │ (Production) │
└─────────────────┴─────────────────┴─────────────────────┘
│ │ │
▼ ▼ ▼
┌─────────────────────────────────────────────────────────┐
│ DOCKER NETWORK (app-network) │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ │
│ │ Node.js App │ │ MySQL 8.0 │ │
│ │ (Port 3000) │◄───┤ Database │ │
│ │ + Health │ │ (Port 3306) │ │
│ │ + Sessions │ │ + Health │ │
│ └─────────────────┘ └─────────────────┘ │
│ │
│ ┌─────────────────┐ ┌─────────────────┐ │
│ │ Adminer │ │ File Volumes │ │
│ │ (Port 8080) │ │ - mysql_data │ │
│ │ DB Admin UI │ │ - app_code │ │
│ └─────────────────┘ └─────────────────┘ │
└─────────────────────────────────────────────────────────┘
│ │ │
▼ ▼ ▼
localhost:3000 localhost:3307 localhost:8080
🔒 Security Best Practices
✅ Change default passwords
✅ Use strong SESSION_SECRET
✅ Never commit .env
✅ Use HTTPS tunnels for production
# Generate secure session secret
openssl rand -base64 32
🚀 Docker Hub Deployment
Image: priyanshuksharma/project-interns
Tags: latest, v1.0.0
# Pull latest
docker pull priyanshuksharma/project-interns:latest
# Run locally
docker run -p 3000:3000 priyanshuksharma/project-interns:latest
📁 Project Structure
project-interns/
├── docker-compose.yml
├── Dockerfile
├── .env
├── sql/
├── src/
├── views/
├── public/
└── config/
🎉 Setup Complete!
🚀 Dev → docker-compose --profile dev up -d
🌐 Share → docker-compose --profile ngrok up -d
🏭 Prod → docker-compose --profile production up -d
Made with ❤️ for Marquardt India Pvt. Ltd.
Tag summary
Content type
Image
Digest
sha256:5c15b045c…
Size
63.7 MB
Last updated
about 1 year ago
docker pull priyanshuksharma/project-interns