Merge pull request #2 from Codaisseur/setup-db

Setup db

Author: Reinoptland

README.md

@@ -26,13 +26,50 @@ cd YOUR_PROJECT_NAME
 npm install
 ```
 
-5. start server with `nodemon` (recommended for development)
+5. Configure your database in `config/config.json`
+
+The default assumes a postgres database with
+
+- username: postgres
+- password: secret
+
+```json
+// config/config.json
+{
+  "development": {
+    "username": "postgres",
+    "password": "secret",
+    "database": "YOUR_PROJECT_NAME_HERE_development",
+    "host": "localhost",
+    "dialect": "postgres",
+    "operatorsAliases": "0"
+  }
+}
+```
+
+6. Create database, run migrations & seed data
+
+`package.json` contains a script for this
+
+```bash
+npm run initdev
+```
+
+Or run the commands seperately
+
+```bash
+npx sequelize-cli db:create
+npx sequelize-cli db:migrate
+npx sequelize-cli db:seed:all
+```
+
+7. start server with `nodemon` (recommended for development)
 
 ```
 npm run dev
 ```
 
-6. or start normally
+8. or start normally
 
 ```
 npm start

config/config.json

@@ -0,0 +1,26 @@
+{
+  "development": {
+    "username": "postgres",
+    "password": "secret",
+    "database": "YOUR_PROJECT_NAME_HERE_development",
+    "host": "localhost",
+    "dialect": "postgres",
+    "operatorsAliases": "0"
+  },
+  "test": {
+    "username": "root",
+    "password": null,
+    "database": "database_test",
+    "host": "127.0.0.1",
+    "dialect": "postgres",
+    "operatorsAliases": "0"
+  },
+  "production": {
+    "username": "root",
+    "password": null,
+    "database": "database_production",
+    "host": "127.0.0.1",
+    "dialect": "postgres",
+    "operatorsAliases": "0"
+  }
+}

migrations/20200318210344-create-user.js

@@ -0,0 +1,37 @@
+"use strict";
+module.exports = {
+  up: (queryInterface, Sequelize) => {
+    return queryInterface.createTable("users", {
+      id: {
+        allowNull: false,
+        autoIncrement: true,
+        primaryKey: true,
+        type: Sequelize.INTEGER
+      },
+      name: {
+        type: Sequelize.STRING,
+        allowNull: false
+      },
+      email: {
+        type: Sequelize.STRING,
+        unique: true,
+        allowNull: false
+      },
+      password: {
+        type: Sequelize.STRING,
+        allowNull: false
+      },
+      createdAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      },
+      updatedAt: {
+        allowNull: false,
+        type: Sequelize.DATE
+      }
+    });
+  },
+  down: (queryInterface, Sequelize) => {
+    return queryInterface.dropTable("users");
+  }
+};

models/index.js

@@ -0,0 +1,37 @@
+'use strict';
+
+const fs = require('fs');
+const path = require('path');
+const Sequelize = require('sequelize');
+const basename = path.basename(__filename);
+const env = process.env.NODE_ENV || 'development';
+const config = require(__dirname + '/../config/config.json')[env];
+const db = {};
+
+let sequelize;
+if (config.use_env_variable) {
+  sequelize = new Sequelize(process.env[config.use_env_variable], config);
+} else {
+  sequelize = new Sequelize(config.database, config.username, config.password, config);
+}
+
+fs
+  .readdirSync(__dirname)
+  .filter(file => {
+    return (file.indexOf('.') !== 0) && (file !== basename) && (file.slice(-3) === '.js');
+  })
+  .forEach(file => {
+    const model = sequelize['import'](path.join(__dirname, file));
+    db[model.name] = model;
+  });
+
+Object.keys(db).forEach(modelName => {
+  if (db[modelName].associate) {
+    db[modelName].associate(db);
+  }
+});
+
+db.sequelize = sequelize;
+db.Sequelize = Sequelize;
+
+module.exports = db;

models/user.js

@@ -0,0 +1,26 @@
+"use strict";
+module.exports = (sequelize, DataTypes) => {
+  const user = sequelize.define(
+    "user",
+    {
+      name: {
+        type: DataTypes.STRING,
+        allowNull: false
+      },
+      email: {
+        type: DataTypes.STRING,
+        unique: true,
+        allowNull: false
+      },
+      password: {
+        type: DataTypes.STRING,
+        allowNull: false
+      }
+    },
+    {}
+  );
+  user.associate = function(models) {
+    // associations can be defined here
+  };
+  return user;
+};