Zero App Client

: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

• Node (12.16.1)

• Webpack (^4.42.0)

• Rollup (^2.3.2)

• ES6 (^7.8.4)

• React (^16.13.0)

• SASS (^4.13.1)

• Jest (^25.1.0)

• Enzyme (^3.11.0)

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

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

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

• Trello board

• PPT Zero

• Wireframe Zero