Basic express server setup
This basic server was made with the purpose of making easier a quick deployment of a Node-based application.
- Basic component-oriented architecture template.
- Eslint setup with Airbnb standard and security plugin.
- Jest as default testing framework.
- OpenAPI 3.0.0 documentation setup.
- MongoDB and Sequelize ready-to-go configuration files.
You can click the Use this template button to make a copy to your own GitHub account!
A .env file can be provided in order to load environment variables. The environment variables used in this template are listed below.
- DEV Can be set to
trueif you are in a development environment, it allows the use ofnodemon. - PORT Default port if you are not in a development environment. Allows a quick deploy to Heroku.
- DB_DIALECT Database dialect, must be set to
mongoif you are using a Mongo database. If you are using a relational database, check the Sequelize documentation to see more about the supported dialects. - DB_HOST Database host.
- DB_NAME Database name.
- DB_USER Database username.
- DB_PASS Database password.
Install dependencies
npm i
Run application
node app.js
You can check the preview at: