Skip to content

Latest commit

 

History

History
98 lines (66 loc) · 3.56 KB

README.md

File metadata and controls

98 lines (66 loc) · 3.56 KB
Raw

Lifecycle:Maturing


Logo

PSA - Digital Journeys

Form Builder and Workflow manager built on top of formsflow.ai.
Dev Env » Docs »

Backlog · Report Bug · Request Feature

About The Project

This repo contains a BC Gov branded version of formsflow.ai that will support public facing and internal Digital Journeys used by PSA and their employees.

(back to top)

Built With

This project is built on top of formsflow.ai which combines Redash, form.io, Camunda, and a custom built Web app to provide a form and workflow management system. See the formsflow.ai for a deeper dive into the different components of the system.

  • Camunda
  • form.io
  • ReDash
  • Keycloak
  • Openshift
  • Postgresql
  • MongoDB
  • Java
  • Python (flask)
  • React

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

  • Docker / docker-compose

Installation

In order to get started with local development, please follow the steps below

  1. Create a .env file in the root of the project. Please contact a project dev to get a working one.
  2. Run the app 
     make run-local
    be patient, this might take a while the first time :)
  3. Once the project is up and running, you can access the web app at localhost:3000.
  4. Update the User role env variables in the .env file according to the Formsflow documentation seeing as these are unique per installation. You can use either the sh script provided there or the postman collection. Note: If you're using the resourceId_*.sh script, you need to run it from within the docker container.
  5. Restart the application, and you should be good to go!

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)