bcgov / court-interpreter-scheduling

Web app for scheduling court interpreters

Court Interpreter Scheduling

Court Interpreter Scheduling

Structure

Dev environment

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

Important commands for the web folder:

npm run-script serve # Serve web under hot reloading npm run-script build # Build production web package

REST API (api)

A FastApi 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):

alembic upgrade head uvicorn app:app --reload --port=8080

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. This can be started up by ./manage start pdf under the docker folder (refer to Running on Docker).

Database (db)

A PostgreSQL database for storage. This can be started up by ./manage start db under the docker folder (refer to Running on Docker). Alternatively a local version could be installed on a different port than the docker container.

Running on Docker

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

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.

High Level Architecture

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.