@cobatech/sunrise
v0.0.4
Published
Sunrise Design System
Downloads
5
Readme
Sunrise
:rocket: Builds Status
Master:
Development:
:nail_care: Test Coverage
Master:
Development:
:memo: Documentation
Requirements
- nvm v0.34.0 (install details)
- Node v12.16.1 (install details)
- npm v5.6.0
Stack
Environment Variables
Application variables
Set Application variables in the .env file
- NODE_ENV
- ENV
- DEV (changes the development mode for the use of the library)
- NPM_TOKEN (token do publish in npm)
Initialization
git clone [email protected]:laborit/sunrise.git
cd sunrise/
cp .env.sample .env
npm i
npm run dev
Build
Build library to production
npm run build
output path /lib
Build client to production
npm run build:dev
output path /dist
Storybook
Use storybook to document library components see more details in storybook documentation
Initialize storybook server
npm run storybook
build storybook static
npm run build-storybook
output path /storybook-static
Testing
Using jest with enzyme and chai (see examples on ./src/**/*.spec.js
)
npm test
npm run test:coverage
Linting
Using eslint
npm run lint
Deploy
NPM package
Locally
Logged in at NPM with your user
Build the library
npm run build
Update package version:
npm version major | minor | patch
see more details in npm-version
Publish the package
npm publish --access public
With Gitlab CI
Set the npm token on gitlab ci environment variable NPM_TOKEN
Before commit, update package version:
npm version major | minor | patch
see more details in npm-version
After than, commit to branch master:
git push origin master
Prettier
- https://prettier.io/ (Supports VSCode, Sublime Text, Vim, Atom and others)
Why?
It removes all original styling and ensures that all outputted code conforms to a consistent style.
As you can see, these two tools we make sure our codebase is consistent across all developers, IDE's and operating systems. Make sure you have them properly configurated on your IDE before starting writing code.