- Git client of your choice
- NodeJS (Installation through brew(macos)/chocolatey(windows) recommended)
- Clone project from https://github.com/
- Run
npm ito install NPM dependencies - Test project with
npm run test
npm run buildprebuild all assetsnpm run devstartup dev server to view project
storybook: Run storybook to work on individual componentsbuild: Build webpack production variant of the applicationdev: Start local webpack dev environmenttest: Execute jest snapshot testing and other teststest:watch: Execute tests and watch for changestest:debug <path to test>: Debug test in chrome debuggerchrome://inspectclickOpen dedicated DevTools for Nodelint: Lints all typscript
Npm versioning will update the packjson and package-lock file. This will help with versioning of the state saved in the local storage. A new version will trigger a reset of a clean state given there might have been state changes on which the application could fail.
npm version patch 0.0.x
npm version minor 0.x.0
npm version major x.0.0
Symantic commit messages enables us to generate changelogs and gives developer ease while viewing the git history.
e.g. test(helper): ensure fetch response object is valid
The format includes type and a subject:
<type>(<optional scope>): <subject>
<body>
Must be one of the following:
- feat: New feature
- fix: Bug fix
- docs: Changes to the documentation
- style: Formatting, missing semi colons, etc; no production code change
- refactor: Refactoring production code, eg. renaming a variable
- test: Adding missing tests, refactoring tests; no production code change
- chore: Changes to the build process or auxiliary tools and libraries
We’ve added hygen, the scalable code generator that saves you time, to the stack so that you can quickly generate a new component using our component standard, which is reflected in the component structure outputted by the command.
Below is an example of issuing the command to create an atom component called my-component.
npx hygen modules component --name my-component --type atomatommoleculeorganism
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent