n5geh.tools.entirety
Built With
- Django 4.1
- Bootstrap 5.2
- htmx 1.8.2
Deployment
To deploy the application please refer to our deployment guide
Contributing
See the contributing guide for detailed instructions on how to get started with our project.
Development
Prerequisites
Installing dependencies
pip
cd ./app/Entirety
pip install -r requirements.txt
pre-commit
pre-commit install
create .env File
cp .env.EXAMPLE .env
Usage
Migrate Database
python manage.py makemigrations
python manage.py migrate
Starting the Django server:
python manage.py runserver
To run the application in your development setup you'll need to provide following settings in your env file.
Required
- DJANGO_SECRET_KEY
- CB_URL
- IOTA_URL
- QL_URL
- DATABASE_USER
- DATABASE_PASSWORD
- DATABASE_HOST
- DATABASE_PORT
Optional
OIDC
- LOCAL_AUTH
- OIDC_OP_AUTHORIZATION_ENDPOINT
- OIDC_OP_JWKS_ENDPOINT
- OIDC_OP_TOKEN_ENDPOINT
- OIDC_OP_USER_ENDPOINT
- OIDC_RP_CLIENT_ID
- OIDC_RP_CLIENT_SECRET
For a full list of settings see settings.
Changelog
See changelog for detailed overview of changes.