@robgietema/generator-nick 0.0.1

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 Rob Gietema
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,54 @@
+# Yeoman Nick App Generator
+
+@robgietema/generator-nick is a Yeoman generator that helps you to set up Nick via command line.
+
+## Installation
+
+First, install [Yeoman](http://yeoman.io) and @robgietema/generator-nick using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).
+
+```bash
+npm install -g yo
+npm install -g @robgietema/generator-nick
+```
+
+## Usage
+
+### Creating a new Nick project using `npm init`
+
+```bash
+npm init yo @robgietema/nick
+```
+
+This is the shortcut for using `npm init` command. It uses Yeoman (`yo`) and `@robgietema/generator-nick` and execute them without having to be installed globally.
+
+Answer the prompt questions to complete the generation process.
+
+### Creating a new Nick project
+
+```bash
+yo @robgietema/nick
+```
+
+This will bootstrap a new Nick project inside the current folder.
+
+### Start Nick with `yarn start`
+
+Start Nick with:
+
+```bash
+yarn start
+```
+
+This runs the project in development mode.
+
+Consult the Nick docs for further details:
+
+https://nickcms.org
+
+### Run unit tests with `yarn test`
+
+Runs all the tests.
+
+### Update translations with `yarn i18n`
+
+Runs the test i18n runner which extracts all the translation strings and generates the needed files.

package/generators/app/index.js

@@ -0,0 +1,148 @@
+const path = require('path');
+const Generator = require('yeoman-generator');
+
+const currentDir = path.basename(process.cwd());
+
+module.exports = class extends Generator {
+  constructor(args, opts) {
+    super(args, opts);
+    this.argument('projectName', {
+      type: String,
+      default: currentDir,
+    });
+    this.option('description', {
+      type: String,
+      desc: 'Project description',
+    });
+
+    this.args = args;
+    this.opts = opts;
+  }
+
+  async prompting() {
+    const updateNotifier = require('update-notifier');
+    const pkg = require('../../package.json');
+    const notifier = updateNotifier({
+      pkg,
+      shouldNotifyInNpmScript: true,
+      updateCheckInterval: 0,
+    });
+    notifier.notify({
+      defer: false,
+      message: `Update available: {currentVersion} -> {latestVersion}
+
+It's important to have the generators updated!
+
+Run "npm install -g @robgietema/generator-nick" to update.`,
+    });
+
+    let props;
+
+    this.globals = {};
+
+    // Project name
+    if (this.args[0]) {
+      this.globals.projectName = this.args[0];
+    } else {
+      if (this.opts['interactive']) {
+        props = await this.prompt([
+          {
+            type: 'input',
+            name: 'projectName',
+            message: 'Project name (e.g. my-nick-project)',
+            default: path.basename(process.cwd()),
+          },
+        ]);
+        this.globals.projectName = props.projectName;
+      } else {
+        this.globals.projectName = path.basename(process.cwd());
+      }
+    }
+
+    // Description
+    if (this.opts.description) {
+      this.globals.projectDescription = this.opts.description;
+    } else {
+      this.globals.projectDescription = 'A Nick-powered Backend';
+    }
+  }
+
+  writing() {
+    const base =
+      currentDir === this.globals.projectName ? '.' : this.globals.projectName;
+    this.fs.copyTpl(
+      this.templatePath('package.json.tpl'),
+      this.destinationPath(base, 'package.json'),
+      this.globals,
+    );
+    this.fs.copyTpl(
+      this.templatePath('config.js.tpl'),
+      this.destinationPath(base, 'config.js'),
+      this.globals,
+    );
+
+    this.fs.copy(this.templatePath(), this.destinationPath(base), {
+      globOptions: {
+        ignore: ['**/*.tpl', '**/*~'],
+        dot: true,
+      },
+    });
+
+    this.fs.copyTpl(
+      this.templatePath('.gitignorefile'),
+      this.destinationPath(base, '.gitignore'),
+      this.globals,
+    );
+
+    this.fs.delete(this.destinationPath(base, 'config.js.tpl'));
+    this.fs.delete(this.destinationPath(base, 'package.json.tpl'));
+    this.fs.delete(this.destinationPath(base, '.gitignorefile'));
+  }
+
+  install() {
+    if (!this.opts['skip-install']) {
+      const base =
+        currentDir === this.globals.projectName
+          ? '.'
+          : this.globals.projectName;
+      this.yarnInstall(null, { cwd: base });
+    }
+  }
+
+  end() {
+    if (!this.opts['skip-install']) {
+      this.log(
+        `
+Done.
+
+Now install and run Postgres and setup the database by entering the following in your Postgres console:
+
+$ CREATE DATABASE ${this.globals.projectName};
+$ CREATE USER nick WITH ENCRYPTED PASSWORD '${this.globals.projectName}';
+$ GRANT ALL PRIVILEGES ON DATABASE ${this.globals.projectName} TO ${this.globals.projectName};
+
+Now go to the ${this.globals.projectName} folder and run:
+
+yarn bootstrap
+yarn start
+`,
+      );
+    } else {
+      this.log(`
+Done.
+
+Now install and run Postgres and setup the database by entering the following in your Postgres console:
+
+$ CREATE DATABASE ${this.globals.projectName};
+$ CREATE USER nick WITH ENCRYPTED PASSWORD '${this.globals.projectName}';
+$ GRANT ALL PRIVILEGES ON DATABASE ${this.globals.projectName} TO ${this.globals.projectName};
+
+Now go to the ${this.globals.projectName} folder and run:
+
+yarn install
+yarn bootstrap
+yarn start
+`);
+    }
+  }
+};

package/generators/app/templates/.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+src/develop/

package/generators/app/templates/.eslintrc

@@ -0,0 +1,9 @@
+{
+  "parserOptions": {
+    "parser": "@babel/eslint-parser",
+    "ecmaVersion": 2022,
+    "sourceType": "module"
+  },
+  "extends": ["prettier"],
+  "plugins": ["json", "prettier"]
+}

package/generators/app/templates/.gitignorefile

@@ -0,0 +1,6 @@
+
+.DS_Store
+node_modules/
+/src/develop
+/config.js
+/var

package/generators/app/templates/.prettierignore

@@ -0,0 +1 @@
+/src/develop

package/generators/app/templates/babel.config.json

@@ -0,0 +1,8 @@
+{
+  "presets": ["@babel/preset-env"],
+  "plugins": [
+    "@babel/transform-runtime",
+    "@babel/plugin-proposal-export-default-from",
+    "add-module-exports"
+  ]
+}

package/generators/app/templates/config.js.tpl

@@ -0,0 +1,39 @@
+export const config = {
+  connection: {
+    port: 5432,
+    host: 'localhost',
+    database: '<%= projectName %>',
+    user: '<%= projectName %>',
+    password: '<%= projectName %>',
+  },
+  blobsDir: `${__dirname}/var/blobstorage`,
+  port: 8000,
+  secret: 'secret',
+  clientMaxSize: '64mb',
+  systemUsers: ['admin', 'anonymous'],
+  systemGroups: ['Owner'],
+  cors: {
+    allowOrigin: '*',
+    allowMethods: '*',
+    allowHeaders: '*',
+    allowCredentials: true,
+    exposeHeaders: '*',
+    maxAge: 3660,
+  },
+  imageScales: {
+    large: [768, 768],
+    preview: [400, 400],
+    mini: [200, 200],
+    thumb: [128, 128],
+    tile: [64, 64],
+    icon: [32, 32],
+    listing: [16, 16],
+  },
+  frontendUrl: 'http://localhost:3000',
+  prefix: '',
+  userRegistration: true,
+  profiles: [
+    `${__dirname}/src/develop/nick/src/profiles/core`,
+    `${__dirname}/src/profiles/default`,
+  ],
+};

package/generators/app/templates/jsconfig.json

@@ -0,0 +1,10 @@
+{
+    "compilerOptions": {
+        "paths": {
+            "@robgietema/nick": [
+                "develop/nick/src"
+            ]
+        },
+        "baseUrl": "src"
+    }
+}

package/generators/app/templates/knexfile.js

@@ -0,0 +1,26 @@
+var path = require('path');
+var { config } = require('./config');
+
+const knexSettings = {
+  client: 'pg',
+  connection: config.connection,
+  pool: {
+    min: 2,
+    max: 10,
+  },
+  migrations: {
+    directory: [
+      path.resolve(__dirname, './src/develop/nick/src/migrations'),
+      path.resolve(__dirname, './src/migrations'),
+    ],
+    tableName: 'knex_migrations',
+  },
+  seeds: {
+    directory: path.resolve(__dirname, './src/develop/nick/src/seeds'),
+  },
+};
+
+module.exports = {
+  development: knexSettings,
+  production: knexSettings,
+};

package/generators/app/templates/mrs.developer.json

@@ -0,0 +1,9 @@
+{
+  "nick": {
+    "package": "@robgietema/nick",
+    "url": "git@github.com:robgietema/nick.git",
+    "https": "https://github.com/robgietema/nick.git",
+    "path": "src",
+    "branch": "main"
+  }
+}

package/generators/app/templates/package.json.tpl

@@ -0,0 +1,49 @@
+{
+  "name": "<%= projectName %>",
+  "description": "",
+  "license": "MIT",
+  "version": "0.0.1",
+  "private": true,
+  "workspaces": [
+    "src/develop/nick"
+  ],
+  "keywords": [
+    "cms"
+  ],
+  "scripts": {
+    "develop": "missdev --config=jsconfig.json --fetch-https",
+    "develop:npx": "npx -p mrs-developer missdev --config=jsconfig.json --fetch-https",
+    "bootstrap": "yarn && yarn migrate && yarn seed",
+    "coverage": "jest --coverage",
+    "i18n": "babel-node scripts/i18n.js",
+    "i18n:ci": "yarn i18n && git diff -G'^[^\"POT]' --exit-code",
+    "knex": "babel-node --plugins ./src/develop/nick/src/plugins/strip-i18n.js node_modules/.bin/knex",
+    "lint": "./node_modules/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx,json}' --no-error-on-unmatched-pattern",
+    "migrate": "yarn knex migrate:latest",
+    "preinstall": "if [ -f $(pwd)/node_modules/.bin/missdev ]; then yarn develop; else yarn develop:npx; fi",
+    "prettier": "./node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,ts,tsx,json}'",
+    "seed": "yarn knex seed:run",
+    "start": "nodemon --exec babel-node src/develop/nick/src/server.js",
+    "rollback": "yarn knex migrate:rollback --all",
+    "reset": "yarn rollback && yarn migrate && yarn seed",
+    "test": "jest --passWithNoTests"
+  },
+  "prettier": {
+    "trailingComma": "all",
+    "singleQuote": true
+  },
+  "jest": {
+    "testPathIgnorePatterns": [
+      "/node_modules/",
+      "/src/develop"
+    ],
+    "setupFilesAfterEnv": [
+      "./src/develop/nick/jest.setup.js"
+    ]
+  },
+  "engines": {
+    "node": "^16.15.0"
+  },
+  "devDependencies": {},
+  "dependencies": {}
+}

package/generators/app/templates/src/profiles/default/documents/_root.json

@@ -0,0 +1,155 @@
+{
+  "uuid": "92a80817-f5b7-400d-8f58-b08126f0f09b",
+  "type": "Site",
+  "title": "Welcome to Nick!",
+  "description": "Congratulations! You have successfully installed Nick.",
+  "owner": "admin",
+  "workflow_state": "published",
+  "created": "2022-04-02T20:00:00.000Z",
+  "modified": "2022-04-02T20:00:00.000Z",
+  "effective": "2022-04-02T20:00:00.000Z",
+
+  "blocks": {
+    "495efb73-cbdd-4bef-935a-a56f70a20854": {
+      "text": {
+        "blocks": [
+          {
+            "key": "9f35d",
+            "data": {},
+            "text": "This is the demo site of Nick and is build with the Volto frontend.",
+            "type": "unstyled",
+            "depth": 0,
+            "entityRanges": [
+              {
+                "key": 0,
+                "length": 4,
+                "offset": 25
+              },
+              {
+                "key": 1,
+                "length": 5,
+                "offset": 52
+              }
+            ],
+            "inlineStyleRanges": []
+          }
+        ],
+        "entityMap": {
+          "0": {
+            "data": {
+              "url": "https://nickcms.org"
+            },
+            "type": "LINK",
+            "mutability": "MUTABLE"
+          },
+          "1": {
+            "data": {
+              "url": "https://voltocms.com"
+            },
+            "type": "LINK",
+            "mutability": "MUTABLE"
+          }
+        }
+      },
+      "@type": "text"
+    },
+    "6a6d1e67-fefd-4049-98a3-300f0302abcb": {
+      "text": {
+        "blocks": [
+          {
+            "key": "3jol2",
+            "data": {},
+            "text": "You can use this site to test the latest version of Nick. You can login with username admin and password admin.",
+            "type": "unstyled",
+            "depth": 0,
+            "entityRanges": [
+              {
+                "key": 0,
+                "length": 4,
+                "offset": 52
+              }
+            ],
+            "inlineStyleRanges": [
+              {
+                "style": "ITALIC",
+                "length": 8,
+                "offset": 77
+              },
+              {
+                "style": "ITALIC",
+                "length": 8,
+                "offset": 96
+              },
+              {
+                "style": "BOLD",
+                "length": 5,
+                "offset": 86
+              },
+              {
+                "style": "BOLD",
+                "length": 5,
+                "offset": 105
+              }
+            ]
+          }
+        ],
+        "entityMap": {
+          "0": {
+            "data": {
+              "url": "https://nickcms.org"
+            },
+            "type": "LINK",
+            "mutability": "MUTABLE"
+          }
+        }
+      },
+      "@type": "text"
+    },
+    "79ba8858-1dd3-4719-b731-5951e32fbf79": {
+      "@type": "title"
+    },
+    "be383a3d-7409-42b5-a5bc-555e2fbf068d": {
+      "text": {
+        "blocks": [
+          {
+            "key": "atc31",
+            "data": {},
+            "text": "This instance is reset every night so feel free to make any changes!",
+            "type": "unstyled",
+            "depth": 0,
+            "entityRanges": [],
+            "inlineStyleRanges": []
+          }
+        ],
+        "entityMap": {}
+      },
+      "@type": "text"
+    },
+    "eb024f35-ab6a-4034-ac5b-77c91fe3d400": {
+      "text": {
+        "blocks": [
+          {
+            "key": "5s8ah",
+            "data": {},
+            "text": "Demo",
+            "type": "header-three",
+            "depth": 0,
+            "entityRanges": [],
+            "inlineStyleRanges": []
+          }
+        ],
+        "entityMap": {}
+      },
+      "@type": "text"
+    }
+  },
+  "blocks_layout": {
+    "items": [
+      "79ba8858-1dd3-4719-b731-5951e32fbf79",
+      "495efb73-cbdd-4bef-935a-a56f70a20854",
+      "eb024f35-ab6a-4034-ac5b-77c91fe3d400",
+      "6a6d1e67-fefd-4049-98a3-300f0302abcb",
+      "be383a3d-7409-42b5-a5bc-555e2fbf068d"
+    ]
+  }
+}

package/generators/app/templates/src/profiles/default/groups.json

@@ -0,0 +1,12 @@
+{
+  "purge": true,
+  "groups": [
+    {
+      "id": "Administrators",
+      "title:i18n": "Administrators",
+      "description:i18n": "",
+      "email": "",
+      "roles": ["Administrator"]
+    }
+  ]
+}

package/generators/app/templates/src/profiles/default/users.json

@@ -0,0 +1,12 @@
+{
+  "purge": false,
+  "users": [
+    {
+      "id": "admin",
+      "password": "admin",
+      "fullname": "Admin",
+      "email": "admin@example.com",
+      "roles": ["Administrator"]
+    }
+  ]
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@robgietema/generator-nick",
+  "description": "Generator for Nick",
+  "maintainers": [
+    {
+      "name": "Rob Gietema",
+      "email": "rob.gietema@gmail.com",
+      "url": "https://robgietema.nl"
+    }
+  ],
+  "license": "MIT",
+  "version": "0.0.1",
+  "repository": {
+    "type": "git",
+    "url": "git@github.com:robgietema/nick.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "bugs": {
+    "url": "https://github.com/robgietema/nick/issues",
+    "email": "info@nickcms.org"
+  },
+  "homepage": "https://nickcms.org",
+  "files": [
+    "generators"
+  ],
+  "keywords": [
+    "yeoman-generator",
+    "cms"
+  ],
+  "engines": {
+    "node": "^16.15.0"
+  },
+  "dependencies": {
+    "update-notifier": "^5.0.1",
+    "yeoman-generator": "^1.0.0"
+  }
+}