@guruhotel/inspire

This project was built with Storybook and Create-react-app

Requeriments

• Yarn for packages management
• NP for manage versions and automatically publish at NPMJS.com

Available Scripts

In the project directory, you can run:

yarn dev

Run development version

yarn build

Compile files to the folder .next

yarn start

Run production version

yarn build-ui

Compile SASS files and React components in ui folder to be used in the NPM package

How to deploy

This is the workflow to make updates:

1. You will need to run yarn install and then yarn dev

2. Every react component must be created on src/components folder and exported on src/index.js

3. Every SASS file (Attached to some react component) must be created on src/sass and exported on main.scss

4. Add the respective component documentation on pages/components

5. Execute yarn build to compile updated files

6. Execute yarn build-ui to compile in the final distribution folder

7. Commit the changes and add a messsage

8. Execute np, select the version to be deployed and that's all, the GitLab repo will be updated and new package into NPMjs.org published.