To launch this project in development mode you'll need to run:
yarn start
To deploy this project to production you'll need to:
yarn build
This project uses the following tools for development and build for production.
- Webpack and webpack-dev-server for bundling and providing a development static server
- Hot module replacement for faster development and debugging
- Ecmascript latest
- Babel along with babel-plugin-transform-class-properties for supporting class properties
- Jest along with enzyme for unit and integration tests
- ESLint along with airbnb rules for JS linting
- conventional-changelog along with commitizen for changelog automatic generation
Several packages were used for this development. But the most important ones would be the following:
- ReactJS for building dynamic UI
- Redux for state management
- Proptypes for type checking on each component's properties
- styled-components for styling
To run unit and integration tests, you'll need to run:
yarn test
To check the project's test coverage, you'll need to run:
yarn coverage - this will serve the test coverage in your browser
or
yarn test --coverage - this will print the coverage report in the terminal
Every project should have a changelog so every one can have an understanding about the project's evolution at each version.
For that we have commitizen along with conventional-changelog to automatically generate a changelog from the project's history.
To generate the changelog file you'll need to run:
yarn changelog