Representation Grant

Representation Grant Application

Structure

Dev environment

Currently it requires: Npm 6.14.14, Node 12, Python 3.8/3.9/3.10. Running on Docker is recommended.

Client Application (web)

An AngularJS client application which serves out the SurveyJS based questionnaire.

REST API (api)

A Django based REST API which provides the heavy lifting. The API includes a Swagger interface containing API documentation and UI that allows you to interact with the various APIs manually.

Important commands for the api folder (May require environment variables set, check settings.py):

python manage.py migrate python manage.py makemigrations python manage.py runserver 8081

Required Environment Variable keys (check settings.py):

DATABASE_SERVICE_NAME, DATABASE_NAME, DATABASE_USER, DATABASE_PASSWORD, DATABASE_ENGINE, DB_SERVICE_HOST, DB_SERVICE_PORT

PDF Microservice (pdf)

An html to PDF microservice used to generate reports.

Database (db)

A PostgreSQL database for storage, complete with a SchemaSpy instance for documentation.

Running on OpenShift

To deploy using a local instance of OpenShift, refer to Running on OpenShift. These instructions, apart from the steps that are specific to setting up your local environment, can be used to get the project deployed to a production OpenShift environment.

Running on Docker

The project can also be run locally using Docker and Docker Compose. Refer to Running with Docker Compose for instructions.

Code of Conduct

Please refer to the Code of Conduct

Contributing

For information on how to contribute, refer to Contributing

License

Code released under the Apache License, Version 2.0.