Local Development
Use this guide to set up ScannerSky locally.
Prerequisites
- Python 3.10+
- PostgreSQL
- Git
Fast Setup
Daily Development
For everyday development work on Windows, run dev_run.bat (or python dev_run.py). It provides a repeatable, non-destructive check of Docker services (PostgreSQL & MinIO), verifies .env, applies database migrations, and launches the Django development server:
dev_run.bat
# or
python dev_run.py
Initial Setup & Backup Restore
For initial environment setup or restoring database and media backups from C:\Users\Admin\Documents\scannersky_backups:
# Windows (Full Docker & Backup Restore Setup)
dev_setup.bat
# or
python dev_setup.py
Manual Setup
python -m venv venv
# Windows
venv\Scripts\activate
# Linux or Mac
source venv/bin/activate
pip install -r requirements.txt
cp .env.example .env
python manage.py migrate
python manage.py collectstatic --noinput
python manage.py createsuperuser
python manage.py runserver
Local URLs
- Home: http://localhost:8000/
- Admin: http://localhost:8000/admin/
- API root: http://localhost:8000/api/
- Public scan page: http://localhost:8000/scan/