Skip to content

Latest commit

 

History

History
109 lines (77 loc) · 3.31 KB

README.md

File metadata and controls

109 lines (77 loc) · 3.31 KB
Raw

🔥 Nikolasmelui Nodejs Boilerplate

Nikolasmelui Nodejs Boilerplate powered by NikolasMelui is a lightweight nodejs boilerplate using eslint, prettier, lint-staged, husky and nodemon onboard. Just clone it, nmp i, npm start and start to create your cool node.js application!

Node.js ^14 version

The project is stricted by the >=14.5.0 node.js version!

Installation

npm i

Config

All necessary configs and your secrets is in the config.js file you need to create by copying the config.example.js:

cp config.example.js config.js

Quick Start

Once everything is installed just run the project:

npm start

You can run the project in the development mode:

npm run develop

Or if you need to debug with an inspector:

npm run debug

Makefile

All npm scripts are in the Makefile, so you can use it:

make <your_command>

Husky and lint-staged onboard

The husky and lint-staged will not let you make a mistake, pre-comit and pre-push are always on guard!

Development

Contribute? Sure! This is an opensource project, so all of the contributions are welcome. Make a fork and go!

Todos Status
Nodemon +
Tests +
ESLint +
Lint-staged +
Prettier +
Husky +
Docker -
CI\CD -

License

MIT License

Copyright (c) 2018 NikolasMelui

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

From developers 2 developers. NikolasMelui