zero-app-client v1.0.0

Zero App Client

Builds Status

Master:

Development:

Test Coverage

Master:

Development:

Documentation

Requirements

• nvm v0.34.0 (install details)
• Node v9.9.0 (install details)
• npm v5.6.0

Stack

• Node
• Webpack
• Rollup
• Storybook
• ES6 (Babel)
• React
• PostCSS / SASS
• Jest / Enzyme / Chai

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/zero-app-client.git
cd zero-app-client/
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

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