Skip to content

๐Ÿ›ฐ๐Ÿš€ Boilerplate usage to start any of your professional Rest API with node.js / express.js / mongoose.js.

License

Notifications You must be signed in to change notification settings

Liroo/node-express-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

4 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Node Express Boilerplate - A modern API boilerplate ๐ŸŒผ

I have no intention to produce a stable open-sourced version of this boilerplate for now. You can use it at your own risk.

Instalation

Install the packages:

yarn

Scripts:
cmd desc
yarn start Start the bundler with hot reloading
yarn build Bundle the API in production mode
yarn prod Start the API in production mode (build needed before)
- -
yarn lint-check Lint check on /api
yarn test Run tests
yarn commit Commit with citizen

I do not use pm2 in the commands or any tools in order to optimize the cluster. I highly recommand to use some of these tools on your own way.

Features

I always try to maintain packages to the last version

  • ExpressJS for http server
  • Mongoose for the mongodb interface (for now, you have to install mongodb on your own way)
  • DotEnv for your env variables
  • Nodemailer with a pug templating for send mail
  • Babel 7 for JavaScript

And a lot more!

Check the package.json for more dependencies used

Contributing

Great that you are considering supporting the project. You have a lot of ways to help us grow. We appreciate all contributions, even the smallest.

  • Report an issue
  • Propose a feature
  • Send a pull request
  • Tell about project around your community

License

The Liroo Node Express Boilerplate is licensed under the MIT license.

About

๐Ÿ›ฐ๐Ÿš€ Boilerplate usage to start any of your professional Rest API with node.js / express.js / mongoose.js.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published