Starter kit for your node.js projects
This boilerplate is not production ready.
- ⭐️ Features
- 📦 Getting started
- 💿 Installation
- 💎 Customization
- ⚙️ Configuration
- 🚀 Deployment
- 🎓 Versioning
- 🧪 Tests
- 💄 Style guide
- Issues
- Authors
- Contributors
- Support
- LICENSE
- Hot Reloading (
npm start
) - Jest unit testing
- Test coverage and badges
- Travis
- Docs
- Love ❤️
- Node.js >=8
This module is distributed via npm which is bundled with node.
git clone https://github.com/nejcm/nodejs-boilerplate.git my-project
npm install
Before shipping, make sure to:
- Edit
LICENSE
file - Edit
package.json
information (These will be used to generate the headers for your built files) - Replace and fill in [FILL], [FILL:...] tags with your information
- Remove any files you do not need or edit them accordingly
Check package.json for configuration options.
npm run build
We use SemVer for versioning. For the versions available see the link to tags on this repository.
npm run tests
The code styles followed are documented and set with linter rules inside .eslintrc file.
Looking to contribute? Look for the Good First Issue label.
Please file an issue for bugs, missing documentation, or unexpected behavior.
Please file an issue to suggest new features. Vote on feature requests by adding a 👍. This helps maintainers prioritize what to work on.
For questions related to using the library, please first read the docs instead of filing an issue on GitHub.
Special thanks to the open source community.
Nejc Muršič 💻 📖 🚇 |
This project follows the all-contributors specification. Contributions of any kind welcome!
Reach out to us at one of the following places: