formsflow.ai leverages form.io to build "serverless" data management applications using a simple drag-and-drop form builder interface.
To know more about form.io, go to https://form.io.
- For docker based installation Docker need to be installed.
Not applicable.
Please note that the forms-flow-forms server is accessed using root user account.
- Make sure you have a Docker machine up and running.
- Make sure your current working directory is "forms-flow-ai/forms-flow-forms".
- Rename the file sample.env to .env.
- Modify the environment variables in the newly created .env file if needed. Environment variables are given in the table below,
- NOTE :
{your-ip-address}given inside the .env file should be changed to your host system IP address. Please take special care to identify the correct IP address if your system has multiple network cards
ℹ️ Variables with trailing 🚩 in below table should be updated in the .env file
| Variable name | Meaning | Possible values | Default value |
|---|---|---|---|
FORMIO_DB_USERNAME |
Mongo Root Username. Used on installation to create the database.Choose your own | admin |
|
FORMIO_DB_PASSWORD |
Mongo Root Password | changeme |
|
FORMIO_DB_NAME |
Mongo Database Name. Used on installation to create the database.Choose your own | formio |
|
FORMIO_ROOT_EMAIL |
forms-flow-forms admin login | eg. [email protected] | [email protected] |
FORMIO_ROOT_PASSWORD |
forms-flow-forms admin password | eg.changeme | changeme |
NO_INSTALL |
to enable/disable UI for Formio client | 1 or 0 | 1 |
FORMIO_DEFAULT_PROJECT_URL🚩 |
forms-flow-forms default url | http://{your-ip-address}:3001 |
|
FORMIO_JWT_SECRET |
forms-flow-forms jwt secret | --- change me now --- |
|
MULTI_TENANCY_ENABLED |
To enable multit tenancy | true / false | false |
Additionally, you may want to change these
- The value of Mongo database details (especially if this instance is not just for testing purposes)
- The value of ROOT user account details (especially if this instance is not just for testing purposes)
-
forms-flow-forms service uses port 3001, make sure the port is available.
-
cd {Your Directory}/forms-flow-ai/forms-flow-forms -
Run
docker-compose up -dto start.
NOTE: Use --build command with the start command to reflect any future .env changes eg : docker-compose up --build -d
- Run
docker-compose stopto stop.
The application should be up and available for use at port defaulted to 3001 in (i.e. http://localhost:3001/)
Default Login Credentials
-----------------
User Name / Email : [email protected]
Password : changeme
formsflow.ai has custom components supported which are created by extending the base components within forms-flow-forms and then registering them within the core renderer.
Custom componets available in formsflow.ai are:
| Component Name | About | How to use |
|---|---|---|
| Text Area with Analytics | To enable Text fields for sentiment analysis processing | link |
If you are interested in adding custom components for your use case in formsflow.ai we highly recommend you to take a look at Custom Component Docs to understand how Form.io renderer allows for the creation of Custom components. You can also take a look at formio.contrib to look for examples and even contribute the custom components you create.
You can add new indexes in Mongodb shell, according to your requirement. You can create indexes like below example:
db.submissions.createIndex({
"data.applicationStatus ": 1
})
In this example:
submissionsis the collection name.data.applicationStatusis the fields which are to be added in index.
We have build formsflow.ai form management platform leveraging formio. We use the OSL-v3 license similar to formio to ensure appropriate attribution is provided to form.io. Please read the license for more information.