Sign in to access MinerSheets revolutionary features
Try searching with different keywords
The backbone of operational excellence
Developer setup for contributing to MinerSheets
This guide is for developers who want to contribute to MinerSheets or set up a development environment. If you're looking to use MinerSheets as an end-user, please see the User Guide instead.
📌 Important: MinerSheets uses a revolutionary Dual Environment Development Methodology for maximum productivity: Native (fast iteration) + Docker (production testing).
Fast iteration with hot reload - perfect for rapid development.
1️⃣ Clone Repository
git clone https://github.com/diofis-enterprise/MinerSheets.git cd MinerSheets
2️⃣ Create Virtual Environment
python3 -m venv venv_dev source venv_dev/bin/activate # Linux/Mac # venv_dev\Scripts\activate # Windows
3️⃣ Install Dependencies
pip install --upgrade pip pip install -r requirements.txt pip install -r requirements-dev.txt
4️⃣ Start PostgreSQL Container
# PostgreSQL will run on port 5434 docker-compose -f config/docker-compose.yml up -d db
5️⃣ Configure Environment
cp .env.development.example .env.development # Edit .env.development with your settings
6️⃣ Run Migrations
python manage.py migrate python manage.py createsuperuser
7️⃣ Start Development Server
python manage.py runserver 0.0.0.0:9319
✅ Visit: http://localhost:9319
Production-like environment for deployment confidence.
2️⃣ Configure Environment
cp .env.development.example .env.development # Edit configuration as needed
3️⃣ Build and Start Containers
docker-compose -f config/docker-compose.yml up -d --build
4️⃣ Run Migrations
docker-compose -f config/docker-compose.yml exec web python manage.py migrate docker-compose -f config/docker-compose.yml exec web python manage.py createsuperuser
5️⃣ Access Application
✅ Visit: http://localhost:9320
Run both environments simultaneously for maximum productivity: Fast iteration + Production confidence.
🚀 Native (Port 9319) 🐳 Docker (Port 9320) ↓ ↓ ├─ Fast Iteration ├─ Production Testing ├─ Hot Reload ├─ Container Validation ├─ IDE Integration ├─ Infrastructure Testing └─ Instant Feedback └─ Deployment Confidence ↓ ↓ └────── Shared PostgreSQL (Port 5434) ──────┘
1️⃣ Setup Native Environment
python3 -m venv venv_dev source venv_dev/bin/activate pip install -r requirements.txt -r requirements-dev.txt
2️⃣ Start Shared Infrastructure
# Start PostgreSQL (5434) and Redis (6379) docker-compose -f config/docker-compose.yml up -d db redis
3️⃣ Start Native Server (9319)
python manage.py runserver 0.0.0.0:9319 &
4️⃣ Start Docker Environment (9320)
docker-compose -f config/docker-compose.yml up -d web
5️⃣ Verify Both Environments
python utils/management_functions.py status
✅ Success!
Native: http://localhost:9319 (fast development) Docker: http://localhost:9320 (production testing)
MinerSheets enforces Zero Bypass Philosophy - quality gates must pass before commits.
Install Pre-commit Hooks
pip install pre-commit pre-commit install
⚠️ Quality Gates
Run All Test Suites
python tests/run_all_tests.py
Runs: Unit + Integration + E2E + API + URL + Quality + Security
Run Specific Test Suite
# Unit tests python tests/unit/test_dynamic_models.py # E2E tests python tests/e2e/test_end_to_end.py # URL structure tests bash tests/e2e/test_professional_urls.sh
Health Check
python utils/management_functions.py health-check
# Find and kill process on port 9319 lsof -ti:9319 | xargs kill -9 # Or use utility function python utils/management_functions.py stop
# Check PostgreSQL status docker ps | grep postgres # Restart database docker-compose -f config/docker-compose.yml restart db
# Reset migrations (dev only) python manage.py migrate schema_builder zero python manage.py migrate
📖 For more troubleshooting tips, see docs/troubleshooting.md
Learn how to contribute code
Understand the system design
Explore REST API endpoints