Developing Hermine

In order to run Hermine in development mode, follow manual installation instructions in the installation guide up to the server part.

Then, use the following commands to run the development server:

# inside poetry environment
python hermine/manage.py runserver

To run the tests, use the following command:

# inside poetry environment
python hermine/manage.py test

To build front modules, use the following command:

npm run install
npm run watch # watch for changes and rebuild

Working with DevContainer

You can also run Hermine inside a DevContainer.

It allows to develop inside a container, in a described and clean environnment. You need to find how to integrate it to your IDE.

The PostCreate command will do the database migrations, you need to create your superuser and run the server. You also need to create your config file from default one.

cp hermine/hermine/config.default.py hermine/hermine/config.py
poetry run python hermine/manage.py createsuperuser
poetry run python hermine/manage.py runserver

Specific aspects

We document here the Hermine-specific aspects of the code. The different FOSS components on which Hermine relies have their own, very useful doc:

• Django documentation

• Django REST Framework documentation

• Django filter

• Pacakge URL (Purl) specification and its Python library

Contents

• Coding standards
  • Developer Certificate of Origin
  • REUSE standard
  • Code linting
  • Naming conventions
  • Commit messages
• The Data Model
  • Models for license management
  • Models for validation rules
  • Models for internal product management
  • Models for 3rd party components
• Permissions
  • Permissions used by Hermine
  • Groups
• Custom tags for Django templates
  • licenseAllowedCSS()
  • licenseCopyleftCSS()
  • licenseFOSSCSS()
  • licenseReviewCSS()
• Tests
  • Running the tests
  • Coverage
• Monitoring performances