/Es6express

Primary LanguageJavaScript

ES6 Node Express Boilerplate

Comes with all the bells and whistles of ES6 modules in a fast and easy to use package

!!! This is configured for use with MongoDB & Mongoose !!!

Considerations

  • We DONT use babel to transpile in this package. Babel is slow(and not great. although just my opinion) This is why the node requirement is so high. To get the best ES6 features you must install the newest node. You can implement babel yourself if you find yourself wanting to use a lower node version. It should be known that package swagger-jsdoc does not play well with babel and you will need to rewrite most of the project meaning you should probably just generate a fresh project instead of copying this one.
  • This project is set-up using swagger for documentation and swagger-jsdoc for automatic documentation. Swagger is extremely customizable and have tons of options. You can review the code to see its basic usage or learn more about it here.
  • We're using bcrypt for crypto functions.(hashing passwords is all its used for atm)
  • Passport is used for all authentication. The project is preconfigured for JWT and local strategies but you can check here for configurations for over 500 different authentication strategies.
  • This comes with GridFS already setup. Check here for more documentation on how to use that.

Setup

Follow these instructions to set up the project. The first two can be skipped however the versions are what this project were generated on and thus I can guarentee they work on those version. I highly suggest you install those versions.

  1. Install node v15.11.0
  2. Install npm v7.6.0
  3. npm i nodemon -g You may skip the -g if you prefer not to install globally. But nodemon suggest installing it globally for better functionality
  4. git clone https://github.com/Arcalise08/Es6express.git
  5. Rename env_template to .env
  6. open .env and replace details with your own
  7. npm i && npm start

Usage

This project isn't meant to be used on its own. Its a boilerplate and should be added to. If your looking for a full fledged express server, look elsewhere. If you're looking for a great starting point for your own express server(And you use mongodb) this is likely for you!

You can npm start and go to localhost:3000/swagger to see the endpoints current available and also test them.