StoneM Front-end Docs
This is the base for the StoneM client. It comes configured with the following tools:
- Redux for state management
- Hot-reloading for React & Redux
- React-Router 4
- Rebass/Styled Components CSS-in-JS modules.
- Babel with preset-env, so you can transpile the featurs you need to support your desired browsers
- Webpack for building
- TSLint with Airbnb config.
- Jest with configuration to support the environment, i.e. TypeScript and Babel, CSS modules and webpack-file-loader.
Looking to contribute code? You may fork this repository and create a topical branch. If you are looking to add a feature that checks the health of masternodes, you may run
git checkout -b feature/check-masternodes-health to create a topical branch for a new feature.
If you're trying to author a fix for a bug, you may run
git checkout -b fix/modal-popup-bug to create a topical fix branch for a modal popup bug.
NPM / Yarn scripts
The following scripts are provided to build, lint, etc:
cleanremoves the build directory
build:devbuilds your site for use in a development environment and outputs it to
build:prodbuilds your site for deployment to a production environment
dev-serverstarts the server for hot reloading
tslintruns TSLint with the configured settings
testruns all your tests with coverage.
We work with TSLint and a mostly unmodified preset for the Airbnb style guide. It is one of the most widely used styleguides by the JS community and offers pretty strict linting too!
Tests are written with Jest and picked up anywhere in the
src directory if they include
Typescript prerequisites go here.
All further information is only relevant if you wish to contribute to this repository. At this time there are no set guidelines for contributing. If you want to add or change something, please open an issue to discuss it and send a pull request. All additions should follow the guidelines for the purpose of this project outlined above.