This page provides a collection of different notes regarding UI development, such as stripes-cli related development.
Configuring Environment
The stripes-cli project can be installed locally but in general the stripes should be used via yarn.
The first step is to make sure that the yarn is installed on the system.
This can be done by directly installing using the appropriate installer for your Operating System or if NPM is already installed then it can be installed via npm.
Installing via npm would be: npm install -g yarn.
Setup a Workspace
A workspace directory should be configured with a package.json file like below and the UI module, such as ui-workflow, cloned in it as a sub-directory.
...
| Note | ||||
|---|---|---|---|---|
Make sure your NPM or Yarn configuration files have the appropriate FOLIO repository setup.
Example Yarn (
The CI Deployment Notes may have further details on this. |
Enabling the UI Module in the Scratch Environment
The scratch environment may need additional work beyond just executing the deployment scripts.
If the module is deployed and enabled but does not appear in the Scratch environment, then the permissions may need to be adjusted.
The following is an example on what is used to ensure ui-workflow is working in the Scratch environment.
| Code Block |
|---|
# stripes okapi login diku_admin --okapi https://folio-dev-aggies-okapi.ci.folio.org --tenant diku
# stripes mod add --okapi https://folio-dev-aggies-okapi.ci.folio.org --user diku_admin --tenant diku
# stripes mod enable --okapi https://folio-dev-aggies-okapi.ci.folio.org --user diku_admin --tenant diku
# stripes app perms | stripes perm assign --okapi https://folio-dev-aggies-okapi.ci.folio.org --user diku_admin --tenant diku |