feat: add migrations to create a default admin and update readme file

Author: VMihalov

README.md

@@ -94,6 +94,18 @@ http://localhost:3000/admin/login
 
 To login in the admin panel, you have to have registered verified user with admin role.
 
+To create a default admin user you can run migrations:
+
+```bash
+mingrate-mongo up
+```
+
+The migrations will create a default admin user in db with creds:
+
+```bash
+login: admin@test.com
+password: String_12345
+```
 
 ![Alt Text2](https://media.giphy.com/media/HdWGgOGfQa0QRLNXME/giphy.gif)
 

generators/admin/steps/writing.js

@@ -17,4 +17,14 @@ module.exports = function() {
     this.destinationPath(`${rootFolder}/src/exceptions`),
     payload,
   );
+  this.fs.copyTpl(
+    this.templatePath(`${adminFolder}/migrations`),
+    this.destinationPath(`${rootFolder}/migrations`),
+    payload,
+  );
+  this.fs.copyTpl(
+    this.templatePath(`${adminFolder}/migrate-mongo-config.js`),
+    this.destinationPath(`${rootFolder}/migrate-mongo-config.js`),
+    payload,
+  );
 };

generators/admin/templates/mongodb/jwt/migrate-mongo-config.js

@@ -0,0 +1,27 @@
+require('dotenv').config();
+
+module.exports = {
+  mongodb: {
+    url: process.env.MONGODB_URL,
+
+    options: {
+      useNewUrlParser: true, // removes a deprecation warning when connecting
+      useUnifiedTopology: true, // removes a deprecating warning when connecting
+      //   connectTimeoutMS: 3600000, // increase connection timeout to 1 hour
+      //   socketTimeoutMS: 3600000, // increase socket timeout to 1 hour
+    },
+  },
+
+  // The migrations dir, can be an relative or absolute path. Only edit this when really necessary.
+  migrationsDir: 'migrations',
+
+  // The mongodb collection where the applied changes are stored. Only edit this when really necessary.
+  changelogCollectionName: 'changelog',
+
+  // The file extension to create migrations and search for in migration dir
+  migrationFileExtension: '.js',
+
+  // Enable the algorithm to create a checksum of the file contents and use that in the comparison to determin
+  // if the file should be run.  Requires that scripts are coded to be run multiple times.
+  useFileHash: false,
+};

generators/admin/templates/mongodb/jwt/migrations/20220707194052-create-basic-admin.js

@@ -0,0 +1,14 @@
+module.exports.up = async (db) => {
+  await db.collection('users').insertOne({
+    email: 'admin@test.com',
+    password: '$2a$10$JBhu1rHrGpk.wx.F6Cta1ujDgENg1XOoZKyeQCS77ZrEMaSsocYQ6',
+    roles: ['user', 'admin'],
+    verified: true,
+  });
+};
+
+module.exports.down = async (db) => {
+  await db.collection('users').deleteOne({
+    email: 'admin@test.com',
+  });
+};

generators/admin/templates/mongodb/passportLocal/migrate-mongo-config.js

@@ -0,0 +1,27 @@
+require('dotenv').config();
+
+module.exports = {
+  mongodb: {
+    url: process.env.MONGODB_URL,
+
+    options: {
+      useNewUrlParser: true, // removes a deprecation warning when connecting
+      useUnifiedTopology: true, // removes a deprecating warning when connecting
+      //   connectTimeoutMS: 3600000, // increase connection timeout to 1 hour
+      //   socketTimeoutMS: 3600000, // increase socket timeout to 1 hour
+    },
+  },
+
+  // The migrations dir, can be an relative or absolute path. Only edit this when really necessary.
+  migrationsDir: 'migrations',
+
+  // The mongodb collection where the applied changes are stored. Only edit this when really necessary.
+  changelogCollectionName: 'changelog',
+
+  // The file extension to create migrations and search for in migration dir
+  migrationFileExtension: '.js',
+
+  // Enable the algorithm to create a checksum of the file contents and use that in the comparison to determin
+  // if the file should be run.  Requires that scripts are coded to be run multiple times.
+  useFileHash: false,
+};

generators/admin/templates/mongodb/passportLocal/migrations/20220707194052-create-basic-admin.js

@@ -0,0 +1,14 @@
+module.exports.up = async (db) => {
+  await db.collection('users').insertOne({
+    email: 'admin@test.com',
+    password: '$2a$10$JBhu1rHrGpk.wx.F6Cta1ujDgENg1XOoZKyeQCS77ZrEMaSsocYQ6',
+    roles: ['user', 'admin'],
+    verified: true,
+  });
+};
+
+module.exports.down = async (db) => {
+  await db.collection('users').deleteOne({
+    email: 'admin@test.com',
+  });
+};