Skip to content
This repository has been archived by the owner on Apr 27, 2022. It is now read-only.

bcgov/Family-Protection-Order

Repository files navigation

Family-Protection-Order

Family Protection Order Form

img

Structure

Dev environment

Currently it needs npm 5.8, node 9.4, e2s installed. running on Docker is recommended

Client Application (fpo-web)

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

REST API (fpo-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.

PDF Microservice (fpo-pdf)

An html to PDF microservice used to generate reports.

Database (fpo-db)

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

Development Instances

Development instances of the application can be found here;

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.