Kalzate Data Model
Why should I use it ?
Using this boilerplate will ease your workflow. It does include a set of well known, common good practices and provides all projects using it a common base where to start from.
Getting started
Install project dependencies:
npm install
Build the application:
npm run build
For committing to Github, please fill the .gitconfig.template file with your Github account info at the root path and rename it to .gitconfig. Consider also the same for .npmrc.template if it is required to publish to a private npm registry. Then, create the Docker image (just for the first time) and run it.
Local Setup
Before running this boilerplate locally, make sure the following dependencies are found in your system.
Then, run either yarn or npm install to install all local dependencies.
Usage
npm run build: Use it for building your project, it produces a ready to ship, production ready, distributable artifact.npm run test: Use it to run your unit & integration test suites. It does also generates a coverage reportnpm run watch:test: Same as running your tests but keep it running whenever your source code or tests are updatednpm run lint: Make it sure your code does compile to Airbnb styling conventionsnpm run validate: This runs the build, test and lint process. If any of them fail it will fail too. This is very handy for using on your CI tool.npm run semantic-release: It releases a new version based on semantic versioning by automatically pushing to Github, incrementing package version and publishing to the npm registry