@deenruv/create 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+# License 1
+
+The MIT License
+
+Copyright (c) 2025-present Aexol
+
+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.
+
+# License 2
+
+The MIT License
+
+Copyright (c) 2018-2025 Michael Bromley
+
+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,52 @@
+# Deenruv Create
+
+A CLI tool for rapidly scaffolding a new Deenruv server application. Heavily inspired by [create-react-app](https://github.com/facebook/create-react-app).
+
+## Usage
+
+Deenruv Create requires [Node.js](https://nodejs.org/en/) v8.9.0+ to be installed.
+
+To create a new project, you may choose one of the following methods:
+
+### npx
+
+```sh
+npx @deenruv/create my-app
+```
+
+_[npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher._
+
+### npm
+
+```sh
+npm init @deenruv my-app
+```
+
+_`npm init <initializer>` is available in npm 6+_
+
+### Yarn
+
+```sh
+yarn create @deenruv my-app
+```
+
+_`yarn create` is available in Yarn 0.25+_
+
+It will create a directory called `my-app` inside the current folder.
+
+## Options
+
+### `--use-npm`
+
+By default, Deenruv Create will detect whether a compatible version of Yarn is installed, and if so will display a prompt to select the preferred package manager.
+You can override this and force it to use npm with the `--use-npm` flag.
+
+### `--log-level`
+
+You can control how much output is generated during the installation and setup with this flag. Valid options are `silent`, `info` and `verbose`. The default is `silent`
+
+Example:
+
+```sh
+npx @deenruv/create my-app --log-level verbose
+```

package/assets/.env.hbs

@@ -0,0 +1,14 @@
+APP_ENV=dev
+COOKIE_SECRET={{ cookieSecret }}
+SUPERADMIN_USERNAME={{{ escapeSingle superadminIdentifier }}}
+SUPERADMIN_PASSWORD={{{ escapeSingle superadminPassword }}}
+{{#if requiresConnection}}
+DB_HOST={{ dbHost }}
+DB_PORT={{ dbPort }}
+DB_NAME={{{ escapeSingle dbName }}}
+DB_USERNAME={{{ escapeSingle dbUserName }}}
+DB_PASSWORD={{{ escapeSingle dbPassword }}}
+{{/if}}
+{{#if dbSchema}}
+DB_SCHEMA={{ dbSchema }}
+{{/if}}

package/assets/Dockerfile.hbs

@@ -0,0 +1,9 @@
+FROM node:20
+
+WORKDIR /usr/src/app
+
+COPY package.json ./
+COPY {{#if useYarn}}yarn.lock{{else}}package-lock.json{{/if}} ./
+RUN {{#if useYarn}}yarn{{else}}npm install{{/if}} --production
+COPY . .
+RUN {{#if useYarn}}yarn{{else}}npm run{{/if}} build

package/assets/deenruv-config.hbs

@@ -0,0 +1,109 @@
+import {
+    dummyPaymentHandler,
+    DefaultJobQueuePlugin,
+    DefaultSearchPlugin,
+    DeenruvConfig,
+} from '@deenruv/core';
+import { defaultEmailHandlers, EmailPlugin } from '@deenruv/email-plugin';
+import { AssetServerPlugin } from '@deenruv/asset-server-plugin';
+import { AdminUiPlugin } from '@deenruv/admin-ui-plugin';
+import 'dotenv/config';
+import path from 'path';
+
+const IS_DEV = process.env.APP_ENV === 'dev';
+
+export const config: DeenruvConfig = {
+    apiOptions: {
+        port: 3000,
+        adminApiPath: 'admin-api',
+        shopApiPath: 'shop-api',
+        // The following options are useful in development mode,
+        // but are best turned off for production for security
+        // reasons.
+        ...(IS_DEV ? {
+            adminApiPlayground: {
+                settings: { 'request.credentials': 'include' },
+            },
+            adminApiDebug: true,
+            shopApiPlayground: {
+                settings: { 'request.credentials': 'include' },
+            },
+            shopApiDebug: true,
+        } : {}),
+    },
+    authOptions: {
+        tokenMethod: ['bearer', 'cookie'],
+        superadminCredentials: {
+            identifier: process.env.SUPERADMIN_USERNAME,
+            password: process.env.SUPERADMIN_PASSWORD,
+        },
+        cookieOptions: {
+          secret: process.env.COOKIE_SECRET,
+        },
+    },
+    dbConnectionOptions: {
+        type: '{{ dbType }}',
+        // See the README.md "Migrations" section for an explanation of
+        // the `synchronize` and `migrations` options.
+        synchronize: false,
+        migrations: [path.join(__dirname, './migrations/*.+(js|ts)')],
+        logging: false,
+        database: {{#if isSQLjs}}new Uint8Array([]){{else if isSQLite}}path.join(__dirname, '../deenruv.sqlite'){{else}}process.env.DB_NAME{{/if}},
+        {{#if dbSchema}}
+        schema: process.env.DB_SCHEMA,
+        {{/if}}
+        {{#if dbSSL}}
+        ssl: true,
+        {{/if}}
+        {{#if isSQLjs}}
+        location: path.join(__dirname, 'deenruv.sqlite'),
+        autoSave: true,
+        {{/if}}
+        {{#if requiresConnection}}
+        host: process.env.DB_HOST,
+        port: +process.env.DB_PORT,
+        username: process.env.DB_USERNAME,
+        password: process.env.DB_PASSWORD,
+        {{/if}}
+    },
+    paymentOptions: {
+        paymentMethodHandlers: [dummyPaymentHandler],
+    },
+    // When adding or altering custom field definitions, the database will
+    // need to be updated. See the "Migrations" section in README.md.
+    customFields: {},
+    plugins: [
+        AssetServerPlugin.init({
+            route: 'assets',
+            assetUploadDir: path.join(__dirname, '../static/assets'),
+            // For local dev, the correct value for assetUrlPrefix should
+            // be guessed correctly, but for production it will usually need
+            // to be set manually to match your production url.
+            assetUrlPrefix: IS_DEV ? undefined : 'https://www.my-shop.com/assets/',
+        }),
+        DefaultJobQueuePlugin.init({ useDatabaseForBuffer: true }),
+        DefaultSearchPlugin.init({ bufferUpdates: false, indexStockStatus: true }),
+        EmailPlugin.init({
+            devMode: true,
+            outputPath: path.join(__dirname, '../static/email/test-emails'),
+            route: 'mailbox',
+            handlers: defaultEmailHandlers,
+            templatePath: path.join(__dirname, '../static/email/templates'),
+            globalTemplateVars: {
+                // The following variables will change depending on your storefront implementation.
+                // Here we are assuming a storefront running at http://localhost:8080.
+                fromAddress: '"example" <noreply@example.com>',
+                verifyEmailAddressUrl: 'http://localhost:8080/verify',
+                passwordResetUrl: 'http://localhost:8080/password-reset',
+                changeEmailAddressUrl: 'http://localhost:8080/verify-email-address-change'
+            },
+        }),
+        AdminUiPlugin.init({
+            route: 'admin',
+            port: 3002,
+            adminUiConfig: {
+                apiPort: 3000,
+            },
+        }),
+    ],
+};

package/assets/docker-compose.hbs

@@ -0,0 +1,39 @@
+version: "3"
+services:
+  server:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    ports:
+      - 3000:3000
+    command: [{{#if useYarn}}"yarn"{{else}}"npm", "run"{{/if}}, "start:server"]
+    volumes:
+      - /usr/src/app
+    environment:
+      DB_HOST: database
+      DB_PORT: 5432
+      DB_NAME: deenruv
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+  worker:
+    build:
+      context: .
+      dockerfile: Dockerfile
+    command: [{{#if useYarn}}"yarn"{{else}}"npm", "run"{{/if}}, "start:worker"]
+    volumes:
+      - /usr/src/app
+    environment:
+      DB_HOST: database
+      DB_PORT: 5432
+      DB_NAME: deenruv
+      DB_USERNAME: postgres
+      DB_PASSWORD: password
+  database:
+    image: postgres
+    volumes:
+      - /var/lib/postgresql/data
+    ports:
+      - 5432:5432
+    environment:
+      POSTGRES_PASSWORD: password
+      POSTGRES_DB: deenruv

package/assets/environment.d.hbs

@@ -0,0 +1,24 @@
+export {};
+
+// Here we declare the members of the process.env object, so that we
+// can use them in our application code in a type-safe manner.
+declare global {
+    namespace NodeJS {
+        interface ProcessEnv {
+            APP_ENV: string;
+            COOKIE_SECRET: string;
+            SUPERADMIN_USERNAME: string;
+            SUPERADMIN_PASSWORD: string;
+            {{#if requiresConnection}}
+            DB_HOST: string;
+            DB_PORT: number;
+            DB_NAME: string;
+            DB_USERNAME: string;
+            DB_PASSWORD: string;
+            {{/if}}
+            {{#if dbSchema}}
+            DB_SCHEMA: string;
+            {{/if}}
+        }
+    }
+}

package/assets/gitignore.template

@@ -0,0 +1,5 @@
+node_modules
+dist
+admin-ui
+static/assets
+static/email/test-emails

package/assets/index-worker.hbs

@@ -0,0 +1,8 @@
+import { bootstrapWorker } from '@deenruv/core';
+import { config } from './deenruv-config';
+
+bootstrapWorker(config)
+    .then(worker => worker.startJobQueue())
+    .catch(err => {
+        console.log(err);
+    });

package/assets/index.hbs

@@ -0,0 +1,8 @@
+import { bootstrap, runMigrations } from '@deenruv/core';
+import { config } from './deenruv-config';
+
+runMigrations(config)
+    .then(() => bootstrap(config))
+    .catch(err => {
+        console.log(err);
+    });