Want to contribute? Check out our Development Guide and join us on Discord!
- Install Python 3.8 (Easiest if this is the only version of python on your computer)
- Install Visual Studio Code
- If using Windows: Install Visual Studio C++ (Within this installer, navigate to C++ Build Tools -> MSVC and Windows 10 SDK)
Install through Docker. Available environment variables:
DEBUG = false //default: true (disabling debug will enable security features)
DATA_DIR = /example/directory //default: none (uses base directory)
USE_ROLLING_SECRET_KEY = true //default: false
DB_ENGINE = MYSQL //default: SQLITE3
MYSQL_CONFIG_FILE = /location/to/file.cnf //default: none
BASE_URL = requests //default: none
USE_SSL = true //default: false
SSL_CERT = /path/to/cert.pem //default: none
SSL_KEY = /path/to/key.poem //default: none
- Pull the repository from GitHub.
- Navigate to the repository folder. At this folder location, open PowerShell as administrator.
- Type
python -m venv venv
to create a virtual environment. - If using Windows: type
set-executionpolicy remotesigned
and select Yes to All to allow Python scripts to run on your computer. - Type
./venv/Scripts/activate
to enter the virtual environment. - Type
pip install -r requirements.txt
to install Python packages within the virtual environment. - Open the project folder in Visual Studio Code (File -> Open Folder).
- Open up the terminal within VS code.
- Create the Django database by typing
./venv/Scripts/python.exe manage.py migrate
. - Create the Django admin account by typing
./venv/Scripts/python.exe manage.py createsuperuser
. - Run the Django project by typing
./venv/Scripts/python.exe manage.py runserver
- GitHub
- GitLens
- Python
- MagicPython
- If your terminal does not show venv (ex.
(venv) ...
), type./venv/Scripts/Activate
. - Type
pip install -r requirements_dev.txt
to install Python packages within the virtual environment. - Enable Python Formatting
- Settings -> Editor: Format On Save ->
ON
- Settings -> Python Formatting Provider ->
Black
- Settings -> Editor: Format On Save ->
- Enabling Python Linting
- Ctrl+Shift+P -> Python: Select Linter ->
pylint
- Settings -> Linting: Pylint Args -> Add Item ->
--disable=line-too-long,bare-except,bad-continuation
- Ctrl+Shift+P -> Python: Select Linter ->