@laborit-dev/sunrise

0.0.1 • Public • Published

Sunrise


🚀 Builds Status

Master:

pipeline status

Development:

pipeline status

💅 Test Coverage

Master:

coverage report

Development:

coverage report


📝 Documentation

Requirements

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 git@gitlab.com:laborit/sunrise.git
cd sunrise/
cp .env.sample .env
npm i
npm run dev

Testing library to localhost

Changes the development mode for the use of the library

npm run build:lib
npm run dev:browser

Build

Build library to production

npm run build:lib

output path /lib

Build client to production

npm run build:dist

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:lib

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

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.

Useful references & links

Readme

Keywords

Package Sidebar

Install

npm i @laborit-dev/sunrise

Weekly Downloads

4

Version

0.0.1

License

none

Unpacked Size

9.35 kB

Total Files

3

Last publish

Collaborators

  • laboritbr-dev