finadvise forms

The finadvise forms library.

This project was bootstrapped with Create React App.

Workflow

For code review / integration we work with feature branches (there is also a tutorial here).

Steps:

• clone remote repository git clone https://**USER**@gitlab.com/finadvise/finadvise-mvp/finadvise-ui-forms.git
• create a local feature branch, either with CLI or in Visual Code

CLI:

• create branch: git branch <branch_name> (f.ex. git branch feature/migr-typescript)
• and switch to branch: git checkout <branch_name>

or in one command

• switch to branch and create if necessary: git checkout -b <branch_name>

in Visual Studio Code

• create branch: "Git: Create Branch..."
• and switch to branch: "Git: Checkout to..."

Naming convention: Prefix with one of the following prefixes: "feature/" or "bugfix/"

• make changes in sources, now working on the feature branch
• commit changes: git add ., git commit -m "commit message"
• periodic rebasing of local feature branch with changes in remote master, if necessary (see stackoverflow): git pull --rebase origin master
• push local changes to remote feature branch: git push origin <branch_name> => the CLI output contain a GitLab link which will generate a corresponding pull request
• create pull request, either manually, or through the provided link
• pull request can be merged on GitLab, typically source branch will be closed
• repo now need to be pulled again, to get merged changes:
  • switch back to master: git checkout master
  • pull repo git pull
• start again with new local feature branch

Available Scripts

In the project directory, you can run:

yarn storybook

Launches the storybook in the browser, with Live Reload. Open http://localhost:9009 to view it in the browser.

yarn test

Launches the test runner in the interactive watch mode.
See the section about running tests for more information.

yarn build

Compiles the typescript files and copies them over to the dist folder.
This is a very crude deployment mechanism, until we have a properly packaged and deployed npm package.

See the section about deployment for more information.

Publishing

The package is publicly published on npm as @finadvise/forms.

Steps:

• npm adduser --scope=@finadvise
• npm publish --access public