Getting Started

Quick introduction to MinerSheets and your first dynamic model

🚀

Developer Quick Start

Get MinerSheets running on your machine in 5 minutes. This is a quick start guide for developers. For end-users, see the User Guide.

5 Minute Setup Docker Ready Production Ready

💎 What is MinerSheets?

MinerSheets is a revolutionary Dynamic Model Factory built with Django 4.2. It allows users to create database models through a web interface, combining Google AppSheet concepts with pure Django implementation excellence.

Key technical features for developers:

Dynamic Model Registration - Runtime model creation without migrations
Live Schema Sync - Direct PostgreSQL schema modifications
Tailwind CSS + Alpine.js - Modern, reactive frontend
RESTful API - Complete API for all operations

Tech Stack:

🐍

Django 4.2.7

Python 3.11+ framework

�

PostgreSQL 15

Production database

🎨

Tailwind + Alpine

Modern reactive UI

�

Docker Ready

Full containerization

Data Collection

Surveys, forms, research data

🎓

Learning & Education

Database concepts, Django tutorials

⚡ Quick Start: Get Running in 5 Minutes

Clone the Repository

Get the latest version from GitHub:

git clone https://github.com/diofis-enterprise/MinerSheets.git
cd MinerSheets

Setup Development Environment

Choose your preferred method:

# Start all services with Docker
docker-compose -f config/docker-compose.yml up -d

# Run migrations
docker-compose -f config/docker-compose.yml exec web python manage.py migrate

# Create superuser
docker-compose -f config/docker-compose.yml exec web python manage.py createsuperuser

# Create virtual environment
python3 -m venv venv_dev
source venv_dev/bin/activate

# Install dependencies
pip install -r requirements.txt -r requirements-dev.txt

# Start PostgreSQL (Docker)
docker-compose -f config/docker-compose.yml up -d db

# Run migrations
python manage.py migrate

# Create superuser
python manage.py createsuperuser

Start the Development Server

# Already running from step 2!
# Access at: http://localhost:9320

✅ Visit http://localhost:9320

python manage.py runserver 0.0.0.0:9319

✅ Visit http://localhost:9319

Explore the Platform

🏠

Landing Page

Public homepage with Community Edition links

🔐

Admin Interface

📊

Dashboard

Manage models and data → /dashboard/

🔌

API Docs

RESTful API reference → /api/docs/

Start Developing

Now you're ready to contribute! Check out these resources:

⚙️

🏗️

🤝