Note: this is what I tested with, your mileage may differ.
- Windows 10
- PostrgeSQL 17.2
- NodeJS v17.3.0
- Python 3.12.7
- Rust 1.63
Defaults is:
- Username:
postgress(POSTGRES_USER) - Password:
zaq123(POSTGRES_PASSWORD) - DB name:
scpwiki(POSTGRES_DB) - DB host:
localhost(DB_PG_HOST) - DB port:
5432(DB_PG_PORT)
You can change it with given environment variables.
- First navigate to
web/jsand executeyarn install - Then navigate to
system/jsand executeyarn install - After that, from the root project directory, run:
pip install -r requirements.txtpython manage.py migratepython manage.py runserver --watch
- Run
python manage.py createsuperuser --username Admin --email "" --skip-checks - Follow instructions in terminal
To start working, the following objects are required:
- Minimally one website record (for localhost)
- Some pages (such as
nav:topornav:side) that are critical for proper appearance
You can provision these basic structures by running the following commands:
python manage.py createsite -s scp-ru -d localhost:8000 -t "SCP Foundation" -H "Russian branch"python manage.py seed -s scp-ru
- Docker 20.10.14
- Docker-Compose 1.29.2
To start the project, use:
docker-compose up
To completely delete all data, use:
docker-compose downrm -rf ./files ./archive ./postgresql
To create users, sites and seed inside the database, start the project and afterwards use syntax such as this:
docker exec -it scpdev_web python manage.py createsite -s scp-ru -d localhost -t "SCP Foundation" -H "Russian branch"docker exec -it scpdev_web seed -s scp-ru
To update current app that is running, do:
docker-compose up -d --no-deps --build web
Note: in more recent versions, you may want to use docker compose instead of docker-compose.