n5geh.tools.entirety

Built With

• Django 4.1
• Bootstrap 5.2
• htmx 1.8.2

Roadmap

Have a look at our roadmap to see what features we plan to work on in the short and long run. We kindly invite you to participate in discussions about possible features as well.

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 -e git+https://jugit.fz-juelich.de/iek-10/public/ict-platform/fiware-applications/[email protected]#egg=jsonschemaparser
  pip install -r requirements.txt

Note: The jsonschemaparser is a package from a repository. It might cause conflicts with other libs. Therefore, we install it separately. Please ignore the relevant ERROR message.

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

• DJANGO_DEBUG
• COMPRESS_ENABLED
• ENTITIES_LOAD
• DEVICES_LOAD
• NOTIFICATIONS_LOAD

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.

User and permissions model

The user and permissions model of Entirety is described in the user model documentation.

Changelog

See changelog for detailed overview of changes.

Contact

@SBlechmann

@sbanoeon

@djs0109

@mwr-ebc

License

Further project information

Acknowledgments

We gratefully acknowledge the financial support of the Federal Ministry
for Economic Affairs and Climate Action (BMWK), promotional references 03EN1030B and 03ET1561B.