Workflow Module

About :open_book:

Workflow is an Open Source project aimed towards the creation of data flow models using config files thereby allowing you to easily create and interact with stateful applications with minimum setup.

Features :dart:

• [x] Can connect to your custom backend
• [ ] Have the edit api in case user wants to edit submitted response
• [ ] Api to customize changes in XML of the form
• [x] Have beautiful themes and widgets
• [x] Are printer-friendly
• [x] Can use very powerful skip and validation logic
• [x] Runs on any device, mobile or desktop, as long as it has a fairly modern browser

Use Case :rocket:

Setup :gear:

Requirements :scroll:

1. Your machine should have Yarn or Npm, Docker, Python installed.

   Note: Preferable Npm version (6.14.15) and Node version(v14.18.1) and Ubuntu OS version(18.04)

2. Check the node and npm version by running following commands.

   node -v
   npm -v

   Method 1 (Using Gitpod)

• Fork this repo 🍴
• Click on the Gitpod button above ☝️
• It opens a complete development setup directly 😄

• No need to clone and struggle with installing packages, managing node versions, banging head on the keyboard, etc (Cool right?)

  This is how it looks 👀

  

  Method 2 (Manually on Local Machine)

1. Fork the repository 🍴

2. Clone the forked repository to your local machine. And goto the root directory of repository.

3. Change the enviroment variables in sample.env or .env file as shown below. It will use the locally created containers and connect to those services.

   REACT_APP_ENKETO_URL=http://localhost:8065
   REACT_APP_FORM_MANAGER_URL=http://localhost:3006
   REACT_APP_HASURA_URL=http://localhost:8080

4. Start the docker services

   docker-compose up -d --build

5. Stop and remove the container of React app named wrapper

   docker ps -aqf "name=wrapper"
   # Use the output `<id>` to stop the wrapper container.
   docker stop <id> && docker rm <id>

6. Navigate to the wrapper directory.

   cd apps\wrapper\

7. Using pnpm to install dependencies and run the app live

   pnpm install
   pnpm run start

NOTE: For local development enketo-express needs node 14 and pnpm@7. Run nvm use 14 && npm i -g pnpm@7 if developing in enketo-express

How to interact?

• If you go to ports on terminal and open the React Wrapper app running on port 3000 you can see a demo UI

  Like This 👇

  

• Currently offering 4 demo flows namely

  • Jumping Forms (Opening of next form once the first one is submitted)
  • Hasura Submissions (Basically saving the form data to any database, hasura extending postgres in this case)
  • Offline capabilites (How the form behaves when working offline)
  • File Upload (How to handle uploading files to any desired CDN, Minio in this case)

Flows Explained 📝

How to integrate custom backend?

In order to achiever this, the submission url in the form spec (covered later below) with your hosted backend.

Future Enhancements :rocket:

• Encrypting query parameters on rendering the enketo form.
• Writing a API for changing an XML form directly from it.
• add npm scripts for install

We are trying to an inversion of control here.

API Docs 🤓

For Get API

curl --location --request GET 'http://localhost:3002/form/form2'

TODO: Add details on the specifications

Possible Attack Vectors

1. XSS (High Priority) - Simple form
2. SQL Injection (High Priority) - needs to be fixed.