Installation

Flowable Forms is hosted in our internal repository. So in order to install you need to set up your credentials.

Configuring .npmrc

You need to add the edoras repository and your credentials to your .npmrc file. You can add these lines to the .npmrc located in your user directory.

@flowable:registry=https://artifacts.flowable.com/artifactory/api/npm/npm-all/
//artifacts.flowable.com/artifactory/api/npm/npm-all/:_password=<BASE64_PASSWORD>
//artifacts.flowable.com/artifactory/api/npm/npm-all/:username=<USERNAME>
//artifacts.flowable.com/artifactory/api/npm/npm-all/:email=youremail@email.com
//artifacts.flowable.com/artifactory/api/npm/npm-all/:always-auth=true

To get your user values, please go to Artifact Repository and click on "Set Me Up".
Then write your password in the top-right and click on the arrow (->) icon.
After that you will find the above example lines replaced with your credentials.

Please remember to replace also the @<SCOPE> value by @flowable in the first line:

@<SCOPE>:registry=https://artifacts.flowable.com/artifactory/api/npm/npm-all/

Once you have your credentials you can install the artifact:

yarn add @flowable/forms

Optional: if you are using TypeScript in your app, install the React types with:

yarn add @types/react --dev

In order to avoid installation issues, please try to use latest version of Yarn.
We recommend to use Yarn >= 1.5