davidfic / Conreq

Conreq Public Alpha Instructions

Want to contribute? Check out our Development Guide and join us on Discord!

Prerequisites

• 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)

Set up the deployment environment

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

Set up the development environment

1. Pull the repository from GitHub.
2. Navigate to the repository folder. At this folder location, open PowerShell as administrator.
3. Type python -m venv venv to create a virtual environment.
4. If using Windows: type set-executionpolicy remotesigned and select Yes to All to allow Python scripts to run on your computer.
5. Type ./venv/Scripts/activate to enter the virtual environment.
6. Type pip install -r requirements.txt to install Python packages within the virtual environment.
7. Open the project folder in Visual Studio Code (File -> Open Folder).
8. Open up the terminal within VS code.
9. Create the Django database by typing ./venv/Scripts/python.exe manage.py migrate.
10. Create the Django admin account by typing ./venv/Scripts/python.exe manage.py createsuperuser.
11. Run the Django project by typing ./venv/Scripts/python.exe manage.py runserver

Visual Studio Code Extensions (Optional)

• GitHub
• GitLens
• Python
• MagicPython

Visual Studio Code Settings (Optional)

1. If your terminal does not show venv (ex. (venv) ...), type ./venv/Scripts/Activate.
2. Type pip install -r requirements_dev.txt to install Python packages within the virtual environment.
3. Enable Python Formatting
   • Settings -> Editor: Format On Save -> ON
   • Settings -> Python Formatting Provider -> Black
4. Enabling Python Linting
   • Ctrl+Shift+P -> Python: Select Linter -> pylint
   • Settings -> Linting: Pylint Args -> Add Item -> --disable=line-too-long,bare-except,bad-continuation

UX Design Mockups

Desktop

Mobile

Screenshots