Folder structure, READMEs

.sequelizerc

@@ -2,5 +2,5 @@ require("dotenv-flow").config();
 
 const path = require("path");
 module.exports = {
-	"config": path.resolve("config", "config.js")
+	"config": path.resolve("config", "sequelize.js")
 };

boilerplates/README.md

@@ -0,0 +1 @@
+## Boilerplates - reusable code templates

config/README.md

@@ -0,0 +1 @@
+## Configuration files and data

controllers/README.md

@@ -0,0 +1 @@
+## Controllers - business logic functions, end of the API route

middleware/README.md

@@ -0,0 +1 @@
+## Middleware - functionalities that must be in the middle of the API route control flow

migrations/README.md

@@ -0,0 +1 @@
+## Database (mainly Sequelize's) migrations

models/README.md

@@ -0,0 +1 @@
+## Database ORM (mainly Sequelize's) models

models/index.js

@@ -5,7 +5,7 @@ const Sequelize = require("sequelize");
 
 const basename = path.basename(__filename);
 const env = process.env.NODE_ENV || "development";
-const config = require(__dirname + "/../config/config.js")[env];
+const config = require(__dirname + "/../config/sequelize.js")[env];
 const db = {};
 
 // Create new Sequelize instance

routes/README.md

@@ -0,0 +1 @@
+## Routes - define control flow of the API route

seeders/README.md

@@ -0,0 +1 @@
+## Database (mainly Sequelize's) seeders - initial data feed, for dummy data and testing

utils/README.md

@@ -0,0 +1 @@
+## General, reusable functionalities unrelated to API

validators/README.md

@@ -0,0 +1 @@
+## Validators - middleware functions for request object validation