Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stevenselcuk/node-boilerplate
Includes some Babel, Webpack, Nodemon, Eslint , PM2 and Huskey particals. Good starting point for your awesome Node.JS server. Also Documentation and testing ready! 🤜🏻
https://github.com/stevenselcuk/node-boilerplate
babel babel-loader babel7 boilerplate boilerplate-template eslint eslintrc node-js nodejs nodejs-server nodemon versioning webpack webpack4
Last synced: 13 days ago
JSON representation
Includes some Babel, Webpack, Nodemon, Eslint , PM2 and Huskey particals. Good starting point for your awesome Node.JS server. Also Documentation and testing ready! 🤜🏻
- Host: GitHub
- URL: https://github.com/stevenselcuk/node-boilerplate
- Owner: stevenselcuk
- Created: 2019-10-04T16:15:33.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T20:15:44.000Z (11 months ago)
- Last Synced: 2023-12-15T22:13:42.458Z (11 months ago)
- Topics: babel, babel-loader, babel7, boilerplate, boilerplate-template, eslint, eslintrc, node-js, nodejs, nodejs-server, nodemon, versioning, webpack, webpack4
- Language: JavaScript
- Homepage:
- Size: 902 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Node Boilerplate 🔥🥔
It's ready to eat! **Just add water.** Tada 🎉
[](https://greenkeeper.io/)
[](https://codeclimate.com/github/stevenselcuk/node-boilerplate/maintainability)
[](https://www.codacy.com/manual/stevenjselcuk/node-boilerplate?utm_source=github.com&utm_medium=referral&utm_content=stevenselcuk/node-boilerplate&utm_campaign=Badge_Grade)
[](https://conventionalcommits.org)
## Features
- [x] Babel 7
- [x] Webpack
- [x] Eslint
- [x] Prettier
- [x] Github Actions
- [x] Documentation (JsDoc)
- [x] Test (Mocha)
- [x] PM2 (Serve)
- [ ] Test Coverage (IDK?)
- [x] Appconveyor
- [ ] Docker
## Utils
- [x] nconf for your args, env and json config management
- [x] Winston For easy logging (file and console)
- [x] Lodash cherry pick 🍒👌
- [x] Signale Good looking console logging
- [x] Lint staged for preventing hot mess
- [x] Huskey for lint and testing hooks before commit and push
- [x] standard-version [See](https://github.com/conventional-changelog/standard-version)
## Init it! ⚡️
Just click **Use this template** button or
```bash
$ git clone https://github.com/stevenselcuk/node-boilerplate yourawesomeproject
$ cd yourawesomeproject
$ yarn
$ yarn dev
```
## Build it! 🔧
```bash
$ yarn build
```
## Start it! 🍍
```bash
$ yarn start
```
## Serve it! 📦
```bash
$ yarn serve
```
## Other Operations 🤔
Linting, fixing and running tests and prettier is in "auto mode" to preventing **"hot mess"**
( just commit and push it 🤜🏻)
### Lint and fix your file
```bash
$ yarn lint
```
### Run your mocha tests
```bash
$ yarn mocha
```
### Generate your documentation
```bash
$ yarn doc
```
## Folder Structure
```coffee
.
├── /dist/ # Ready to serving files 🥘
├── /src/ # Your awesome Node project 💵
│ ├── /utils/ # Some helpers for you 👄
│ ├── logger.js # File/console Logging helper
│ ├── config.js # Manage and use your .env,args and config.json (Ready to use. Really)
│ ├── index.js # Your entry point!
└── /test/ # Mocha test files, config and helpers are here
└── /docs/ # Your generated documentation files (JSDoc)
└── /logs/ # Log files by logger.js and PM2
└── README.md # You are reading this
└── pm2.config.js # Some configs for running PM2
└── package.json # Node packages
```
# 🙌🏻 That's all brothers.