express-ecma-boilerplate-mongodb

A minimalistic express ecma boilerplate with mongodb

Usage no npm install needed!

<script type="module">
  import expressEcmaBoilerplateMongodb from 'https://cdn.skypack.dev/express-ecma-boilerplate-mongodb';
</script>

README

Express ECMA Boilerplate With MongoDB

This is a minimalistic express boilerplate with the following features:

  • ECMA features enabled
  • Dotenv Load environment variables from .env file
  • Prettier to prettify the code
  • MongoDB ready to go configuration with mongoose
  • CORS feature enabled
  • Passport local authentication strategy and middleware to restrict access.
  • Error Handling errors custom middleware and helpers globally configured
  • Multer File Uploading middleware configured to use in routes as middleware
  • Axios globally configured in ./src/utils/api.utils.js
  • Swagger documentation reachable at http://localhost:3000/api/v1/docs
  • Docker ready configuration with multi-stage option
  • Best practices in naming files

Basic Information

  • App entry point is located in ./src/app.js

  • Server config entrypoint is located in ./src/bin/www.js

  • Babel config to transpile the code is located at ./.babel.rc

  • Prettier config is located at ./.prettierrc.js

  • Passport config is located at ./src/config/passport.config.js

    • Local Strategy is defined in ./src/services/passport/passport-local.service.js

  • Mongo config is located at ./src/config/database.config.js

    • Models definition are located in ./src/services

  • Error Handling middleware is located at ./src/middlewares/errorHandler.middleware.js

    • You can configure as many errors you need in ./src/helpers/errors.helper.js

  • Swagger config file is located at ./swagger.json

    • Swagger routes are defined in ./src/routes/swagger.route.js

  • Docker config is located at ./Dockerfile

Folder Structure

src/

  • bin/ - server configuration folder
  • config/ - here you find all the configuration files (database, passport, etc...)
  • constants/ - here you can put all you global constants
  • controllers/ - all the controllers to use in routes that interact with services
  • helpers/ - some helpers func i.e. an error helper that returns json everytime an error comes in
  • middlewares/ - here you can find all the custom middlewares
  • models/ - database model definition
  • routes/ - here you find all the defined routes of the app
  • services/ - here we store all the services; i.e. here we define methods to manipulate a db model entity
  • utils/ - containing some utils function to be reused in the code (i.e. axios global configuration)

Getting Started

Copy the .env.local to .env

cp env.local .env
# Then replace the string in .env file MONGO_URI with your connection

To get started with this repo npm install in the root folder

npm install

To getting started with a dev environment. Here we use nodemon and babel-node to restart the server asa we change something

npm run dev

To transpile the code and create a production build

npm run transpile

This command will create a build in the root directory

To start with a production ready build you can run this command

# This set the NODE_ENV to production, npm-run-all, create a build and run the server command
npm run start

If you have a build and you want to node the build you can run

# This command launch the node instance inside the ./build/bin/www
npm run server

Docker Ready

Here we use the multistage build to optimize speed and size of the final image

If you use Docker and wanna dockerize the app you can run the command

docker build -t <dockerhubusername>/<docker-image-name>:<tag> .

then

docker run --name <docker-process-name> -d - p 3000:3000 <dockerhubusername>/<docker-image-name>:<tag>