@chronomics/chronomics-registration
v1.5.7
Published
This library is used in [fe-app-chronomics](https://bitbucket.org/chronomics/fe-app-chronomics/) to display the registration workflow.
Downloads
231
Maintainers
Keywords
Readme
Chronomics Registration
This library is used in fe-app-chronomics to display the registration workflow.
On stage, the workflow is hosted here and can be completed with a valid kit id or order number for testing purposes.
Requirements
- nodejs should ideally match node version from fe-app-chronomics
Getting started
Without linking
Pointing to stage
cp .env.example .env # fill in the values with stage endpoints for ease of development
yarn install
yarn start
Navigate to /register
.
Pointing to mock server
- Install dependencies
yarn
- in a tab, start mock server
yarn run start:server
- in another tab, start app
cp .env.example.mock .env
yarn start
open http://localhost:8000/register
TODO: add more mock orders matching different scenarios to the mock database under the key orders
.
post
calls (e.g. tests) will modify the database.json file, feel free to commit or revert them as appropriate.
With linking
This library can be linked to fe-app-chronomics.
Caveats
The front-end cannot be started from a container due to the way linking works i.e. symbolic links to files.
The linking of react is needed if we want to keep react as a development dependency.
Getting started
cd ../fe-app-chronomics/node_modules/react
yarn link
cd ../../../registration-process
yarn link react
yarn link
yarn build-lib --watch
cd ../fe-app-chronomics
yarn link @chronomics/chronomics-registration
yarn start
Navigate to http://localhost:3000/register
Unlinking
cd path/to/fe-app-chronomics
yarn unlink @chronomics/chronomics-registration
yarn install --force
Caveat
The styles are not built until the library is used on the front-end.
If you wish to see the styles before the library is added to the front-end:
mkdir src/dev-styles
cp -r ../fe-app-chronomics/src/img ../registration-process/src/dev-styles
cp -r ../fe-app-chronomics/src/fonts ../registration-process/src/dev-styles
cp -r ../fe-app-chronomics/src/sass ../registration-process/src/dev-styles
sed -i '' '1i\'$'\n''import "./dev-styles/sass/app.scss";'$'\n' src/index.tsx
Publishing to npm
This private package is published to npm
via buddy
The publish pipeline is manually triggered.
Once the library is deployed, bump the matching version in fe-app-chronomics.
Caveat:
The secret belongs to a member of the organisation, any password changes or leaving the organisation can make the secret obsolete.
Configuration
Currently, this project consists of multiple API endpoints which are passed as props in the initial component as props.