create-vitnode-app 0.0.7-canary.7 → 0.0.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-vitnode-app",
-  "version": "0.0.7-canary.7",
+  "version": "0.0.7",
   "description": "Create a new VitNode app in seconds.",
   "author": "VitNode Team",
   "license": "MIT",
@@ -10,13 +10,21 @@
     "url": "git+https://github.com/aXenDeveloper/VitNode.git",
     "directory": "packages/create-vitnode-app"
   },
-  "files": [
-    "dist"
-  ],
   "type": "module",
   "bin": {
     "create-vitnode-app": "dist/index.cjs"
   },
+  "keywords": [
+    "vitnode",
+    "react",
+    "next",
+    "nest",
+    "nextjs",
+    "nestjs",
+    "typescript",
+    "next.js",
+    "nest.js"
+  ],
   "dependencies": {
     "figlet": "^1.7.0",
     "picocolors": "^1.0.1",
@@ -24,14 +32,17 @@
     "validate-npm-package-name": "^5.0.1"
   },
   "devDependencies": {
+    "@types/cross-spawn": "^6.0.6",
     "@types/figlet": "^1.5.8",
-    "@types/node": "^20",
+    "@types/node": "^20.14.11",
     "@types/prompts": "^2.4.9",
     "@types/validate-npm-package-name": "^4.0.2",
     "commander": "^12.1.0",
+    "cross-spawn": "^7.0.3",
+    "ora": "^8.0.1",
     "tsup": "^8.1.0",
-    "typescript": "^5",
-    "eslint-config-typescript-vitnode": "0.0.7-canary.7"
+    "typescript": "^5.5.3",
+    "eslint-config-typescript-vitnode": "0.0.7"
   },
   "scripts": {
     "lint": "eslint .",

package/templates/basic/.gitignore_template

@@ -0,0 +1,55 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# Dependencies
+node_modules
+.pnp
+.pnp.js
+
+# Local env files
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+# Testing
+coverage
+
+# Turbo
+.turbo
+
+# Vercel
+.vercel
+
+# Build Outputs
+.next/
+out/
+build
+dist
+
+
+# Debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Misc
+.DS_Store
+*.pem
+
+# Docker
+/docker
+
+# Others
+/apps/backend/uploads/public/*
+/apps/backend/uploads/private/*
+/apps/backend/uploads/temp/*
+!/apps/backend/uploads/index.html
+!/apps/backend/uploads/public/index.html
+!/apps/backend/uploads/private/index.html
+!/apps/backend/uploads/temp/index.html
+/apps/backend/schema.gql
+
+# Configuration
+/apps/backend/src/plugins/*/admin/database/migrations
+/apps/backend/src/plugins/core/

package/templates/basic/.npmrc_template

@@ -0,0 +1 @@
+package-manager-strict=false

package/templates/basic/apps/backend/nest-cli.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json.schemastore.org/nest-cli",
+  "collection": "@nestjs/schematics",
+  "sourceRoot": "src",
+  "compilerOptions": {
+    "deleteOutDir": true,
+    "builder": {
+      "type": "swc",
+      "options": {
+        "extensions": [".ts", ".tsx"]
+      }
+    },
+    "typeCheck": true
+  }
+}

package/templates/basic/apps/backend/src/app.module.ts

@@ -0,0 +1,23 @@
+import { join } from 'path';
+
+import { Module } from '@nestjs/common';
+import { VitNodeCoreModule } from 'vitnode-backend';
+
+import { PluginsModule } from './plugins/plugins.module';
+import { DATABASE_ENVS, schemaDatabase } from './database';
+
+@Module({
+  imports: [
+    VitNodeCoreModule.register({
+      paths: {
+        envFile: join(process.cwd(), '..', '..', '.env'),
+      },
+      database: {
+        config: DATABASE_ENVS,
+        schemaDatabase,
+      },
+    }),
+    PluginsModule,
+  ],
+})
+export class AppModule {}

package/templates/basic/apps/backend/src/database.ts

@@ -0,0 +1,19 @@
+// ! DO NOT REMOVE, MODIFY OR MOVE THIS FILE!!!
+
+import tableCore from '@/plugins/core/admin/database/index';
+import tableWelcome from '@/plugins/welcome/admin/database/index';
+// ! === IMPORT ===
+
+export const schemaDatabase = {
+  ...tableWelcome,
+  // ! === MODULE ===
+  ...tableCore,
+};
+
+export const DATABASE_ENVS = {
+  host: process.env.DB_HOST || 'localhost',
+  port: process.env.DB_PORT ? +process.env.DB_PORT : 5432,
+  user: process.env.DB_USER || 'root',
+  password: process.env.DB_PASSWORD || 'root',
+  database: process.env.DB_DATABASE || 'vitnode',
+};

package/templates/basic/apps/backend/src/main.ts

@@ -0,0 +1,27 @@
+/* eslint-disable no-console */
+import { NestFactory } from '@nestjs/core';
+import { INestApplication } from '@nestjs/common';
+import { nestjsMainApp } from 'vitnode-backend';
+
+import { AppModule } from './app.module';
+
+async function bootstrap() {
+  const app: INestApplication = await NestFactory.create(AppModule);
+
+  nestjsMainApp(app, {
+    cors: {
+      origin: [
+        process.env.NEXT_PUBLIC_FRONTEND_URL
+          ? process.env.NEXT_PUBLIC_FRONTEND_URL
+          : 'http://localhost:3000',
+      ],
+    },
+  });
+
+  await app.listen(process.env.PORT ?? '8080', null, () => {
+    console.log(
+      `Application is running on: http://localhost:${process.env.PORT ?? 8080}/graphql`,
+    );
+  });
+}
+bootstrap();

package/templates/basic/apps/backend/src/plugins/plugins.module.ts

@@ -0,0 +1,14 @@
+// ! DO NOT REMOVE, MODIFY OR MOVE THIS FILE!!!
+
+import { Module } from '@nestjs/common';
+
+import { WelcomeModule } from './welcome/welcome.module';
+// ! === IMPORT ===
+
+@Module({
+  imports: [
+    WelcomeModule,
+    // ! === MODULE ===
+  ],
+})
+export class PluginsModule {}

package/templates/basic/apps/backend/src/plugins/welcome/admin/admin.module.ts

@@ -0,0 +1,4 @@
+import { Module } from '@nestjs/common';
+
+@Module({})
+export class AdminWelcomeModule {}

package/templates/basic/apps/backend/src/plugins/welcome/admin/database/drizzle.config.ts

@@ -0,0 +1,11 @@
+// ! DO NOT REMOVE, MODIFY OR MOVE THIS FILE!!!
+import { defineConfig } from 'drizzle-kit';
+
+import { DATABASE_ENVS } from '@/database';
+
+export default defineConfig({
+  dialect: 'postgresql',
+  dbCredentials: DATABASE_ENVS,
+  schema: './plugins/welcome/admin/database/schema/*.ts',
+  out: './plugins/welcome/admin/database/migrations/',
+});

package/templates/basic/apps/backend/src/plugins/welcome/admin/database/functions.ts

@@ -0,0 +1,6 @@
+// ! DO NOT REMOVE, MODIFY OR MOVE THIS FILE!!!
+import { default as tables } from './index';
+
+export const getTables = () => {
+  return Object.keys(tables);
+};

package/templates/basic/apps/backend/src/plugins/welcome/admin/database/index.ts

@@ -0,0 +1 @@
+export default {};

package/templates/basic/apps/backend/src/plugins/welcome/config.json

@@ -0,0 +1,10 @@
+{
+  "name": "Welcome",
+  "description": "Basic plugin with default page.",
+  "code": "welcome",
+  "author": "VitNode",
+  "author_url": "https://vitnode.com/",
+  "support_url": "https://github.com/aXenDeveloper/vitnode/issues",
+  "allow_default": true,
+  "nav": []
+}

package/templates/basic/apps/backend/src/plugins/welcome/versions.json

@@ -0,0 +1,3 @@
+{
+  "10000": "1.0.0"
+}

package/templates/basic/apps/backend/src/plugins/welcome/welcome.module.ts

@@ -0,0 +1,8 @@
+import { Module } from '@nestjs/common';
+
+import { AdminWelcomeModule } from './admin/admin.module';
+
+@Module({
+  imports: [AdminWelcomeModule],
+})
+export class WelcomeModule {}

package/templates/basic/apps/backend/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts", "uploads"]
+}

package/templates/basic/apps/backend/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "eslint-config-typescript-vitnode/tsconfig.nest.json",
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "commonjs",
+    "baseUrl": "./",
+    "outDir": "./dist",
+    "paths": {
+      "@/*": ["./src/*", "./node_modules/vitnode-backend/dist/*"]
+    }
+  },
+  "exclude": ["uploads"]
+}

package/templates/basic/apps/frontend/app/[locale]/layout.tsx

@@ -0,0 +1,13 @@
+import React from 'react';
+import { GeistSans } from 'geist/font/sans';
+import {
+  RootLayout,
+  RootLayoutProps,
+  generateMetadataRootLayout,
+} from 'vitnode-frontend/views/layout/root-layout';
+
+export const generateMetadata = generateMetadataRootLayout;
+
+export default function Layout(props: RootLayoutProps) {
+  return <RootLayout className={GeistSans.className} {...props} />;
+}

package/templates/basic/apps/frontend/app/global.css

@@ -0,0 +1,82 @@
+@tailwind components;
+@tailwind utilities;
+@tailwind base;
+
+@layer base {
+  * {
+    @apply border-border;
+  }
+
+  body {
+    @apply bg-background text-foreground;
+  }
+
+  a {
+    @apply text-primary;
+    @apply cursor-pointer;
+  }
+
+  :root {
+    --background: 220 40% 98%;
+    --foreground: 213deg 5% 8%;
+    --card: 220 40% 100%;
+    --card-foreground: 213deg 26% 7%;
+    --popover: var(--card);
+    --popover-foreground: var(--card-foreground);
+    --primary: 220 74% 50%;
+    --primary-foreground: 220 40% 98%;
+    --secondary: 0 0% 100%;
+    --secondary-foreground: 210 40% 2%;
+    --muted: 220 40% 96%;
+    --muted-foreground: 220 8% 44%;
+    --accent: 220 40% 92%;
+    --accent-foreground: 222 47% 11%;
+    --destructive: 0 57% 43%;
+    --destructive-foreground: 210 40% 98%;
+    --border: 220 20% 90%;
+    --input: var(--border);
+    --ring: var(--primary);
+    --radius: 0.5rem;
+    --cover: 220 80% 67%;
+    --cover-foreground: 210 40% 98%;
+  }
+
+  .dark {
+    --background: 216 32% 7%;
+    --foreground: 0 0% 98%;
+    --card: 216 32% 10%;
+    --card-foreground: 0 0% 98%;
+    /* --popover: var(--card); */
+    /* --popover-foreground: var(--card-foreground); */
+    --primary: 216 84% 59%;
+    --primary-foreground: 216 40% 98%;
+    --secondary: 222 25% 18%;
+    --secondary-foreground: 0 0% 98%;
+    --muted: 216 32% 11%;
+    --muted-foreground: 216 18% 64%;
+    --accent: 216 32% 14%;
+    --accent-foreground: 0 0% 98%;
+    --destructive: 359 78% 55%;
+    --destructive-foreground: 210 40% 98%;
+    --border: 216 25% 16%;
+    /* --input: var(--border); */
+    /* --ring: var(--primary); */
+    --cover: 216 64% 39%;
+    --cover-foreground: 210 40% 98%;
+  }
+}
+
+@layer utilities {
+  .underline-strike-through {
+    text-decoration: underline line-through;
+  }
+
+  .no-scrollbar {
+    -ms-overflow-style: none;
+    scrollbar-width: none;
+
+    &::-webkit-scrollbar {
+      display: none;
+    }
+  }
+}

package/templates/basic/apps/frontend/app/layout.tsx

@@ -0,0 +1,9 @@
+import './global.css';
+
+export default async function RootLayout({
+  children,
+}: {
+  children: React.ReactNode;
+}) {
+  return children;
+}

package/templates/basic/apps/frontend/i18n.ts

@@ -0,0 +1,13 @@
+import { getRequestConfig } from 'next-intl/server';
+import { i18nConfig } from 'vitnode-frontend/i18n';
+
+export default getRequestConfig(async args => {
+  const config = await i18nConfig({
+    ...args,
+    pathsToMessagesFromPlugins: async ({ plugin, locale }) => {
+      return import(`./plugins/${plugin}/langs/${locale}.json`);
+    },
+  });
+
+  return config;
+});

package/templates/basic/apps/frontend/middleware.ts

@@ -0,0 +1,7 @@
+import createMiddleware from 'vitnode-frontend/middleware';
+
+export default createMiddleware();
+
+export const config = {
+  matcher: '/((?!_next/static|_next/image|robots.txt|sitemap.xml|sitemap).*)',
+};

package/templates/basic/apps/frontend/next.config.mjs

@@ -0,0 +1,6 @@
+import VitNodeConfig from 'vitnode-frontend/next.config';
+
+/** @type {import('next').NextConfig} */
+const nextConfig = {};
+
+export default VitNodeConfig(nextConfig);

package/templates/basic/apps/frontend/plugins/welcome/langs/en.json

@@ -0,0 +1,5 @@
+{
+  "welcome": {
+    "admin": {}
+  }
+}

package/templates/basic/apps/frontend/plugins/welcome/langs/pl.json

@@ -0,0 +1,5 @@
+{
+  "welcome": {
+    "admin": {}
+  }
+}

package/templates/basic/apps/frontend/plugins/welcome/templates/default-page.tsx

@@ -0,0 +1,3 @@
+export default function DefaultPage() {
+  return <div className="container my-4">Default Page for welcome</div>;
+}

package/templates/basic/apps/frontend/postcss.config.mjs

@@ -0,0 +1,9 @@
+/** @type {import('postcss-load-config').Config} */
+const config = {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+};
+
+export default config;

package/templates/basic/apps/frontend/tailwind.config.ts

@@ -0,0 +1,15 @@
+import { Config } from 'tailwindcss';
+import vitnodeConfig from 'vitnode-frontend/tailwind.config';
+
+const config = {
+  presets: [vitnodeConfig],
+  content: [
+    '../../node_modules/vitnode-frontend/src/components/**/*.tsx',
+    '../../node_modules/vitnode-frontend/src/views/**/*.tsx',
+    './components/**/*.{ts,tsx}',
+    './app/**/*.{ts,tsx}',
+    './plugins/templates/**/*.{ts,tsx}',
+  ],
+} satisfies Config;
+
+export default config;

package/templates/basic/apps/frontend/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "eslint-config-typescript-vitnode/tsconfig.next.json",
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "baseUrl": "./",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "plugins": [
+      {
+        "name": "next"
+      }
+    ],
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"]
+}

package/templates/basic/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig",
+  "extends": "eslint-config-typescript-vitnode/tsconfig.shared.json"
+}

package/templates/basic/turbo.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "https://turbo.build/schema.json",
+  "tasks": {
+    "build": {
+      "outputs": [".next/**", "!.next/cache/**", "dist/**"],
+      "dependsOn": ["^build"]
+    },
+    "start": {
+      "outputs": [".next/**", "!.next/cache/**", "dist/**"],
+      "dependsOn": ["^start"],
+      "persistent": true
+    },
+    "config:init": {
+      "dependsOn": ["^config:init"]
+    },
+    "lint": {
+      "dependsOn": ["^lint"]
+    },
+    "lint:fix": {
+      "dependsOn": ["^lint:fix"]
+    },
+    "dev": {
+      "cache": false,
+      "persistent": true
+    }
+  }
+}

package/templates/docker/docker-compose-dev.yml

@@ -0,0 +1,35 @@
+version: '3.8'
+
+services:
+  database:
+    container_name: vitnode_postgres_development
+    image: postgres:16.3-alpine
+    restart: unless-stopped
+    environment:
+      POSTGRES_USER: ${DB_USER-root}
+      POSTGRES_PASSWORD: ${DB_PASSWORD-root}
+      POSTGRES_DB: vitnode
+    command: ['postgres', '-c', 'log_statement=all'] # log all sql queries
+    volumes:
+      - ./docker/dev/database:/var/lib/postgresql/data
+    ports:
+      - '5432:5432'
+    networks:
+      - vitnode_dev
+
+  pgadmin:
+    container_name: vitnode_pgadmin_development
+    image: dpage/pgadmin4:latest
+    restart: unless-stopped
+    environment:
+      PGADMIN_DEFAULT_EMAIL: admin@admin.com
+      PGADMIN_DEFAULT_PASSWORD: admin
+    ports:
+      - '5050:80'
+    depends_on:
+      - database
+    networks:
+      - vitnode_dev
+
+networks:
+  vitnode_dev:

package/templates/eslint/.prettierrc.mjs

@@ -0,0 +1,11 @@
+import vitnodePrettier from "eslint-config-typescript-vitnode/prettierrc.mjs";
+
+/**
+ * @see https://prettier.io/docs/en/configuration.html
+ * @type {import("prettier").Config}
+ */
+const config = {
+  ...vitnodePrettier,
+};
+
+export default config;

package/templates/eslint/apps/backend/.eslintrc.json

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://json.schemastore.org/eslintrc",
+  "extends": ["eslint-config-typescript-vitnode/.eslintrc.shared.json"],
+  "ignorePatterns": ["uploads"]
+}

package/templates/eslint/apps/frontend/.eslintrc.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://json.schemastore.org/eslintrc",
+  "extends": ["eslint-config-typescript-vitnode/.eslintrc.react.json"]
+}

package/templates/install-dependencies.ts

@@ -0,0 +1,53 @@
+import color from 'picocolors';
+import spawn from 'cross-spawn';
+
+import { CreateCliReturn } from '../cli';
+import { getOnline } from '../helpers/is-online';
+
+export const installDependencies = async ({
+  packageManager: pm,
+}: Pick<CreateCliReturn, 'packageManager'>) => {
+  const packageManager = pm.split('@')[0];
+  const isOnline = await getOnline();
+  const args: string[] =
+    packageManager === 'npm' ? ['install', '--force'] : ['install'];
+
+  if (!isOnline) {
+    console.log(
+      color.yellow(
+        'You appear to be offline.\nFalling back to the local cache.',
+      ),
+    );
+    args.push('--offline');
+  }
+
+  /**
+   * Return a Promise that resolves once the installation is finished.
+   */
+  return new Promise<void>((resolve, reject) => {
+    /**
+     * Spawn the installation process.
+     */
+    const child = spawn(packageManager, args, {
+      stdio: 'ignore', // Change 'inherit' to 'ignore'
+      env: {
+        ...process.env,
+        ADBLOCK: '1',
+        // we set NODE_ENV to development as pnpm skips dev
+        // dependencies when production
+        NODE_ENV: 'development',
+        DISABLE_OPENCOLLECTIVE: '1',
+      },
+    });
+    child.on('close', code => {
+      if (code !== 0) {
+        // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
+        reject({ command: `${packageManager} ${args.join(' ')}` });
+
+        return;
+      }
+
+      resolve();
+    });
+  });
+};

package/templates/pnpm/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+packages:
+  - 'apps/*'