Merge pull request #51 from VMihalov/feature/adminjs

Add adminjs

Author: v-checha

README.md

@@ -78,6 +78,37 @@ use Exclude decorator to exclude properties from serialization
 
 - Nodemailer
 
+### AdminJS
+
+AdminJS is available to use if you select Mongo + JWT/Passport, on the route:
+
+```bash
+http://localhost:3000/admin
+```
+
+If you are not logged in, you will be redirected to the admin login page.
+
+```bash
+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)
+
 ## Requirements
 
 - node >= 14

generators/admin/arguments/index.js

@@ -0,0 +1,17 @@
+/**
+ * Exports object that contains names of arguments as a key and their configuration objects as a value
+ *
+ * @example
+ * module.exports = {
+ *   argumentName: {
+ *     desc: 'Description for the argument',
+ *     required: false,
+ *     optional: true,
+ *     type: String || Number || Array || Object,
+ *     defaults: 'Default value for this argument',
+ *     banner: 'String to show on usage notes'
+ *   }
+ * };
+ */
+
+module.exports = {};

generators/admin/dependencies/dependencies.json

@@ -0,0 +1,10 @@
+{
+ "general": {
+   "@adminjs/express": "4.1.3",
+   "@adminjs/mongoose": "2.0.4",
+   "@adminjs/nestjs": "4.0.1",
+   "@adminjs/passwords": "2.0.2",
+   "adminjs": "5.10.4"
+ },
+ "dev": {}
+}

generators/admin/dependencies/index.js

@@ -0,0 +1,17 @@
+const dependenciesObj = require('./dependencies.json');
+
+function getStableDep(dependenciesObj, versions) {
+  const depArray = Object.entries(dependenciesObj[versions]).map(entriesArr => {
+    return entriesArr.join('@');
+  });
+
+  return depArray.join(' ');
+}
+
+module.exports = function() {
+  return Object.keys(dependenciesObj).reduce((acc, versions) => {
+    acc[versions] = getStableDep(dependenciesObj, versions);
+
+    return acc;
+  }, {});
+};

generators/admin/index.js

@@ -0,0 +1,46 @@
+const Generator = require('yeoman-generator');
+
+const generatorArguments = require('./arguments');
+const generatorOptions = require('./options');
+const generatorSteps = require('./steps');
+
+module.exports = class AdminGenerator extends Generator {
+  constructor(args, options) {
+    super(args, options);
+
+    Object.keys(generatorArguments).forEach(key => {
+      return this.argument(key, generatorArguments[key]);
+    });
+    Object.keys(generatorOptions).forEach(key => {
+      return this.option(key, generatorOptions[key]);
+    });
+  }
+
+  get configuring() {
+    return generatorSteps.configuring;
+  }
+
+  get conflicts() {
+    return generatorSteps.conflicts;
+  }
+
+  get end() {
+    return generatorSteps.end;
+  }
+
+  get initializing() {
+    return generatorSteps.init;
+  }
+
+  get install() {
+    return generatorSteps.install;
+  }
+
+  get prompting() {
+    return generatorSteps.prompting;
+  }
+
+  get writing() {
+    return generatorSteps.writing;
+  }
+};

generators/admin/options/index.js

@@ -0,0 +1 @@
+module.exports = {};

generators/admin/questions/index.js

@@ -0,0 +1 @@
+module.exports = {};

generators/admin/steps/configuring.js

@@ -0,0 +1,6 @@
+/**
+ * Step 3
+ * Saving configurations and configure the project
+ */
+
+module.exports = function() {};

generators/admin/steps/conflicts.js

@@ -0,0 +1,8 @@
+/**
+ * Step 6
+ * Where conflicts are handled (used internally)
+ */
+
+module.exports = function() {
+  this.conflicter.force = true
+};

generators/admin/steps/end.js

@@ -0,0 +1,6 @@
+/**
+ * Step 8
+ * Called last, cleanup, say good bye, etc
+ */
+
+module.exports = function() {};