@nejcm/react-boilerplate v1.1.8
React boilerplate
Table of Contents
- โญ๏ธ Features
- ๐ฆ Getting started
- ๐ฟ Installation
- ๐ Customization
- โ๏ธ Configuration
- ๐ Deployment
- ๐ Versioning
- ๐งช Tests
- ๐ Style guide
- Issues
- Authors
- Contributors
- Support
- LICENSE
โญ๏ธ Features
- Generated with CRA
- Webpack 4
- Babel 7
- Hot Reloading (
npm start) - CSS Autoprefixer
- SASS/SCSS support
- Jest unit testing
- Test coverage and badges
- Travis
- Docs
- File templates for TODO, README, CONTRIBUTING, ISSUE_TEMPLATE, etc...
๐ฆ Getting Started
Built With
- Love :heart:
Prerequisites
- React >=16
- Node.js >=8
๐ฟ Installation
This module is distributed via npm which is bundled with node.
git clone https://github.com/nejcm/react-boilerplate.git my-project
npm install๐ Customization
Before shipping, make sure to: 1. Edit
LICENSEfile 2. Editpackage.jsoninformation (These will be used to generate the headers for your built files) 3. Replace and fill in FILL, FILL:... tags with your information 4. Remove any files you do not need or edit them accordingly
โ๏ธ Configuration
Check package.json for configuration options.
๐ Deployment
npm run build๐ Versioning
We use SemVer for versioning. For the versions available see the link to tags on this repository.
๐งช Tests
npm run tests๐ Style guide
The code styles followed are documented and set with linter rules inside .eslintrc file.
Issues
Looking to contribute? Look for the Good First Issue label.
๐ Bugs
Please file an issue for bugs, missing documentation, or unexpected behavior.
๐ก Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding a ๐. This helps maintainers prioritize what to work on.
โ Questions
For questions related to using the library, please first read the docs instead of filing an issue on GitHub.
Authors
Special thanks to the open source community.
Contributors
This project follows the all-contributors specification. Contributions of any kind welcome!
Support
Reach out to us at one of the following places: