@solidstarters/create-solid-app 1.2.12

package/helpers.js

@@ -0,0 +1,216 @@
+import chalk from 'chalk';
+import crypto from 'crypto';
+import { execa } from 'execa';
+import fs from 'fs-extra';
+import os from 'os';
+import path, { dirname } from 'path';
+import { fileURLToPath } from 'url';
+
+
+// Simulate __dirname
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+export async function copyAndInstallTemplate(source, target) {
+  try {
+    // Copy the source folder to the target folder
+    await copyTemplate(source, target); 
+
+    // Run `npm install` in the target directory
+    return await installTemplate(target);
+    // console.log(chalk.green(`Dependencies installed in ${target}`));
+  } catch (error) {
+    console.error(chalk.red('Error in copyAndInstallTemplate:', error));
+    throw error;
+  }
+}
+
+async function installTemplate(target) {
+  const output = await execa('npm', ['install'], { stdio: 'inherit', cwd: target });
+  return output;
+}
+
+export async function copyTemplate(source, target) {
+  try {
+    await fs.copy(source, target);
+    // console.log(chalk.green(`Files copied from ${source} to ${target}`));
+    // Check if there is a dot-templates folder in the target
+    handleHiddenTemplateFiles(target);
+  }
+  catch (error) {
+    console.error(chalk.red('Error in copyTemplate:', error));
+    throw error;
+  }
+}
+
+function handleHiddenTemplateFiles(target) {
+  const dotTemplatesPath = path.join(target, 'dot-templates');
+  // move all the files from dot-templates to the target after remove .template in the file name
+  if (fs.existsSync(dotTemplatesPath)) {
+    const files = fs.readdirSync(dotTemplatesPath);
+    files.forEach(file => {
+      const newFileName = file.replace('dot.', '.').replace('.template', '');
+      fs.moveSync(path.join(dotTemplatesPath, file), path.join(target, newFileName));
+    });
+    fs.removeSync(dotTemplatesPath);
+  }
+}
+
+export function getSourceFolderPath(folder) {
+  const folderPath = path.join(__dirname, folder);
+  if (!fs.existsSync(folderPath)) {
+    const error = `Source folder ${folderPath} does not exist`;
+    console.error(chalk.red(error));
+    throw new Error(error);
+  }
+  return folderPath;
+}
+
+export function updatePackageName(targetPath, subProject, packageName) {
+  try {
+    const packageJsonPath = path.join(targetPath, subProject, 'package.json');
+
+    // Check if package.json exists
+    if (!fs.existsSync(packageJsonPath)) {
+      const error = `package.json not found at ${packageJsonPath}`;
+      console.error(chalk.red(error));
+      throw new Error(error);
+    }
+
+    // Read, modify, and write the package.json
+    const packageJson = fs.readJsonSync(packageJsonPath);
+    packageJson.name = packageName;
+    fs.writeJsonSync(packageJsonPath, packageJson, { spaces: 2 });
+    // console.log(chalk.green(`Updated package name to "${packageName}" in ${packageJsonPath}`));
+  } catch (error) {
+    console.error(chalk.red('Error in updatePackageName:', error));
+    throw error;
+  }
+}
+
+export function updatePortInPackageJson(targetPath, subProject, port) {
+  try {
+    const packageJsonPath = path.join(targetPath, subProject, 'package.json');
+
+    // Check if package.json exists
+    if (!fs.existsSync(packageJsonPath)) {
+      const error = `package.json not found at ${packageJsonPath}`;
+      console.error(chalk.red(error));
+      throw new Error(error);
+    }
+
+    // Read, modify, and write the package.json
+    const packageJson = fs.readJsonSync(packageJsonPath);
+    packageJson.scripts.dev = `next dev -p ${port}`;
+    fs.writeJsonSync(packageJsonPath, packageJson, { spaces: 2 });
+    packageJson.scripts.start = `next start -p ${port}`;
+    fs.writeJsonSync(packageJsonPath, packageJson, { spaces: 2 });
+  } catch (error) {
+    console.error(chalk.red('Error in updatePortInPackageJson:', error));
+    throw error;
+  }
+}
+
+export function getBackendEnvConfig(answers) {
+  const envConfig = {
+    "General": {
+      ENV: 'prod', //FIXME: preferred dev, Need to asses impact of keeping it as dev
+      PORT: answers.solidApiPort,
+      SOLID_APP_NAME: answers.projectName,
+    },
+    "Default DB Configuration": {
+      DEFAULT_DATABASE_USER: answers.solidApiDatabaseUsername,
+      DEFAULT_DATABASE_PASSWORD: answers.solidApiDatabasePassword,
+      DEFAULT_DATABASE_NAME: answers.solidApiDatabaseName,
+      DEFAULT_DATABASE_PORT: answers.solidApiDatabasePort,
+      DEFAULT_DATABASE_HOST: answers.solidApiDatabaseHost,
+      DEFAULT_DATABASE_SYNCHRONIZE: answers.solidApiDatabaseSynchronize,
+      DEFAULT_DATABASE_LOGGING: false,
+    },
+    "IAM Registration": {
+      IAM_PASSWORD_LESS_REGISTRATION: false,
+      IAM_PASSWORD_LESS_REGISTRATION_VALIDATE_WHAT: 'transactional',
+      IAM_ALLOW_PUBLIC_REGISTRATION: true,
+      IAM_ACTIVATE_USER_ON_REGISTRATION: true,
+      IAM_DEFAULT_ROLE: 'Admin',
+    },
+    "IAM JWT": {
+      IAM_JWT_TOKEN_AUDIENCE: `http://localhost:${answers.solidApiPort}`,
+      IAM_JWT_TOKEN_ISSUER: answers.projectName,
+      IAM_JWT_SECRET: generateJwtSecret(),
+    },
+  }
+  return envConfig;
+}
+
+export function getFrontendEnvJson(answers) {
+  const envConfig = {
+    "General": {
+      API_URL: `http://localhost:${answers.solidApiPort}`, //FIXME duplicate of NEXT_PUBLIC_BACKEND_API_URL. need to cleanup
+      NEXTAUTH_URL: `http://localhost:${answers.solidUiPort}`,
+      NEXT_PUBLIC_BACKEND_API_URL: `http://localhost:${answers.solidApiPort}`,
+      NEXT_PUBLIC_SOLID_ENTITIES: '',
+      NEXT_PUBLIC_SOLID_APP_TITLE: answers.projectName,
+      NEXT_PUBLIC_SOLID_APP_DESCRIPTION: '',
+      NEXT_PUBLIC_ENABLE_CUSTOM_HEADER_FOOTER: false,
+      NEXT_PUBLIC_DEFAULT_MENU_KEY: `${answers.projectName}-tracker`,
+    }
+  };
+  return envConfig;
+}
+
+export function generateEnvFileFromConfig(targetPath, envConfig) {
+  try {
+    const envPath = path.join(targetPath, '.env');
+    let envContent = '';
+    // Get the keys of the env groups
+    for (const group in envConfig) {
+      envContent += `\n# ${group}\n`;
+      // Get the keys of the env variables in the group
+      for (const key in envConfig[group]) {
+        const value = envConfig[group][key];
+        if (value) {
+          envContent += `${key}=${value}\n`;
+        }
+      }
+    }
+    fs.writeFileSync(envPath, envContent);
+  } catch (error) {
+    console.error(chalk.red('Error in generateEnvFileFromJson:', error));
+    throw error;
+  }
+}
+
+function generateJwtSecret() {
+  return crypto.randomBytes(64).toString('hex'); // 64 bytes => 128 characters in hexadecimal
+};
+
+export async function installSolidAsGlobalBinary(cwd) {
+  try {
+    await execa('npm', ['run', 'build'], { stdio: 'inherit', cwd });
+
+    const nodeVersion = process.version;
+    const homeDir = os.homedir();
+    const binaryPath = path.join(homeDir, `.nvm/versions/node/${nodeVersion}/bin/solid`);
+
+    try {
+      await execa('rm', [binaryPath], { stdio: 'inherit' });
+    } catch (error) {
+    }
+
+    await execa('npm', ['i', '-g'], { stdio: 'inherit', cwd });
+  } catch (error) {
+    console.error(chalk.red('Error during installation:', error.message));
+    process.exit(1);
+  }
+}
+
+// This function takes a label and a value and prints them to the console
+export function prettyOutput(label, value, helpText = null) {
+  const formattedLabel = label ? chalk.magenta(label) : '';
+  const paddedLabel = formattedLabel.padEnd(10);
+  const outputLabel = formattedLabel ? `${paddedLabel}:` : paddedLabel;
+  const formattedHelpText = helpText ? chalk.cyan(`(${helpText})`) : '';
+  const outputHelpText = formattedHelpText ? `\n${''.padEnd(10)} ${formattedHelpText}` : '';
+  return `${outputLabel} ${chalk.green(value)}${outputHelpText}\n`;
+}

package/index.js

@@ -0,0 +1,71 @@
+#!/usr/bin/env node
+
+import chalk from 'chalk';
+import { copyAndInstallTemplate, generateEnvFileFromConfig, getBackendEnvConfig, getFrontendEnvJson, getSourceFolderPath, updatePackageName, installSolidAsGlobalBinary, prettyOutput, updatePortInPackageJson, copyTemplate } from './helpers.js';
+import inquirer from 'inquirer';
+import path from 'path';
+import fs from 'fs-extra';
+import { setupQuestions } from './setup-questions.js';
+import _ from 'lodash';
+
+
+async function main() {
+    try {
+        console.log(chalk.cyan("Hello, Let's setup your Solid project!"));
+
+        // Questions for the user to setup backend
+        const answers = await inquirer.prompt(setupQuestions);
+
+        const projectName = _.kebabCase(answers.projectName.trim());
+        const targetPath = path.join(process.cwd(), projectName);
+
+        // Step 1: Check if the folder already exists
+        if (fs.existsSync(targetPath)) {
+            console.log(chalk.red(`Error: Directory ${projectName} already exists.`));
+            process.exit(1);
+        }
+
+        // Step 2: Setup the sub projects from the templates
+        console.log(prettyOutput('Step 1','Setting up boilerplate for the backend'));
+        const templatesPath = getSourceFolderPath('templates');
+        // copyTemplate(path.join(templatesPath, 'dot.templates'), targetPath);
+
+        await copyAndInstallTemplate(path.join(templatesPath, 'nest-template'), path.join(targetPath, 'solid-api'));
+        
+        console.log(prettyOutput('Step 2','Installing solid binary globally'));
+        const ignore = await installSolidAsGlobalBinary(path.join(targetPath, 'solid-api'));
+
+        console.log(prettyOutput('Step 3',`Setting up boilerplate for the frontend`));
+        await copyAndInstallTemplate(path.join(templatesPath, 'next-template'), path.join(targetPath, 'solid-ui'));
+
+        // Step 3: Update project package json details
+        updatePackageName(targetPath, 'solid-ui', `@${projectName}/solid-ui`);
+        updatePackageName(targetPath, 'solid-api', `@${projectName}/solid-api`);
+        updatePortInPackageJson(targetPath, 'solid-ui', answers.solidUiPort);
+
+        // Step 4: Generate the .env files for backend and frontend
+        const backendPath = path.join(targetPath, 'solid-api');
+        console.log(prettyOutput('Step 4',`Generating .env file for the backend at ${chalk.cyan(backendPath)}`));
+        generateEnvFileFromConfig(backendPath, getBackendEnvConfig(answers));
+        const frontendPath = path.join(targetPath, 'solid-ui');
+        console.log(prettyOutput('Step 5',`Generating .env file for the frontend at ${chalk.cyan(frontendPath)}`));
+        generateEnvFileFromConfig(frontendPath, getFrontendEnvJson(answers));
+
+        // Step 5: Notify the user
+        console.log(chalk.green(`Project ${chalk.cyan(projectName)} created successfully!`));
+        console.log(chalk.cyan(`\nEnsure the database is created and connection is established correctly.`));
+        console.log(chalk.cyan(`\nNext steps:`));
+        console.log(chalk.cyan(`Run the api:`));
+        console.log(prettyOutput('',`cd ${projectName}/solid-api`));
+        console.log(prettyOutput('','solid seed -s ModuleMetadataSeederService','This will seed the database with the required metadata'));
+        console.log(prettyOutput('','npm run start',`This will start the backend server @http://localhost:${answers.solidApiPort}`));
+        console.log(chalk.cyan(`\nRun the frontend:`));
+        console.log(prettyOutput('',`cd ${projectName}/solid-ui`));
+        console.log(prettyOutput('','npm run dev',`This will start the frontend server @http://localhost:${answers.solidUiPort}`));
+    }
+    catch (err) {
+        console.error('Error:', err);
+    }
+}
+main();
+

package/optional_dependencies.testcases

@@ -0,0 +1,30 @@
+I.)
+# If sms queues = false
+# If otp url is not sent 
+
+below error is shown:
+Instead there should be a check in the constructor throwing a proper error
+s_provider_template_id" AS "SmsTemplate_sms_provider_template_id", "SmsTemplate"."description" AS "SmsTemplate_description", "SmsTemplate"."active" AS "SmsTemplate_active" FROM "ss_sms_template" "SmsTemplate" WHERE ( (("SmsTemplate"."name" = $1)) ) AND ( "SmsTemplate"."deleted_at" IS NULL ) LIMIT 1 Parameters: otp-on-register
+node:internal/process/promises:289
+            triggerUncaughtException(err, true /* fromPromise */);
+            ^
+
+TypeError: Invalid URL
+    at new URL (node:internal/url:804:36)
+    at dispatchHttpRequest (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/adapters/http.js:232:20)
+    at <anonymous> (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/adapters/http.js:152:5)
+    at new Promise (<anonymous>)
+    at wrapAsync (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/adapters/http.js:132:10)
+    at http (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/adapters/http.js:170:10)
+    at Axios.dispatchRequest (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/core/dispatchRequest.js:51:10)
+    at Axios._request (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/core/Axios.js:178:33)
+    at Axios.request (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/core/Axios.js:40:25)
+    at Axios.httpMethod (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/core/Axios.js:217:19)
+    at Axios.request (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/axios/lib/core/Axios.js:45:41)
+    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
+    at Msg91OTPService.sendSMSSynchronously (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/@solidstarters/solid-core/src/services/sms/Msg91OTPService.ts:35:9)
+    at Msg91OTPService.sendSMSUsingTemplate (/Users/oswald/projects/Solid_Starters/my-solid-app/solid-api/node_modules/@solidstarters/solid-core/src/services/sms/Msg91BaseSMSService.ts:67:13) {
+  code: 'ERR_INVALID_URL',
+  input: 'undefined/otp?otp=358004&template_id=666bd246d6fc051047560595&mobile=9198201691070&authkey=undefined'
+
+  II.)

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@solidstarters/create-solid-app",
+  "version": "1.2.12",
+  "main": "index.js",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "description": "",
+  "type": "module",
+  "bin": {
+    "create-solid-app": "index.js"
+  },
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^12.1.0",
+    "degit": "^2.8.4",
+    "execa": "9.5.2",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^12.2.0",
+    "lodash": "^4.17.21"
+  }
+}

package/setup-questions.js

@@ -0,0 +1,208 @@
+export const setupQuestions = [
+    {
+        type: 'input',
+        name: 'projectName',
+        message: 'What is the name of your project?',
+        default: 'my-solid-app', // Default value if the user skips
+    },
+    // 2. Choose your backend api port name i.e default 3000
+    {
+        type: 'input',
+        name: 'solidApiPort',
+        message: 'Choose your backend api port',
+        default: '3000',
+    },
+    {
+        type: 'list',
+        name: 'solidApiDatabaseClient',
+        message: 'Choose your default database client',
+        choices: ['pg', 'mysql'],
+        default: 'pg',
+    },
+    {
+        type: 'input',
+        name: 'solidApiDatabaseUsername',
+        message: 'Please provide your database username',
+    },
+    {
+        type: 'password',
+        name: 'solidApiDatabasePassword',
+        message: 'Please provide your database password',
+    },
+    {
+        type: 'input',
+        name: 'solidApiDatabaseName',
+        message: 'Please provide your database name',
+    },
+//             6. Please provide your database host? i.e default localhost
+    {
+        type: 'input',
+        name: 'solidApiDatabaseHost',
+        message: 'Please provide your database host',
+        default: 'localhost',
+    },
+// 7. Please provide your database port? i.e default 5432
+    {
+        type: 'input',
+        name: 'solidApiDatabasePort',
+        message: 'Please provide your database port',
+        default: '5432',
+    },
+    // 8. Do you want to keep your models and database synchronized i.e default true (highlight the risks)
+    {
+        type: 'confirm',
+        name: 'solidApiDatabaseSynchronize',
+        message: 'Do you want to keep your models and database synchronized?. This setting is not recommended for production environments.',
+        default: true,
+    },
+// 6. Do you want to enable caching yes/no i.e default no ??
+//     - Choose your default cache provider? redis i.e default redis
+//         - Please provide hostname
+//         - Please provide port
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableCaching',
+    //     message: 'Do you want to enable caching?',
+    //     default: false,                
+    // },
+// 7. Do you want to enable queues yes/ no i.e default no ??
+//     - Choose your default queue broker rabbitmq i.e default rabbitmq
+//         - Please provide your broker url
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableQueues',
+    //     message: 'Do you want to enable queues?',
+    //     default: false,
+    // },
+// 8. Do you want to enable mongodb yes / no i.e default no ??
+//     - Please provide your mongodb connection string
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableMongo',
+    //     message: 'Do you want to enable mongodb?',
+    //     default: false,
+    // },
+// 9. Do you want to enable s3 i.e default no ??
+//     - Please provide AWS region name?
+//     - Please provide AWS access key?
+//     - Please provide AWS secret key?
+//     - Please provide bucket name? i.e default radix-dev-public
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableS3',
+    //     message: 'Do you want to enable s3?',
+    //     default: false,
+    // },
+// 9. Choose your default Email provider type i.e SMTP/API
+//     - Please provide SMTP username?
+//     - Please provide SMTP password?
+//     - Please provide SMTP host?
+//     - Please provide SMTP port? i.e default 587
+//     - Please provide your default from email address
+    // {
+    //     type: 'list',
+    //     name: 'solidApiEmailProvider',
+    //     message: 'Choose your default Email provider type',
+    //     choices: ['SMTP', 'API'],
+    //     default: 'SMTP',
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiEmailUsername',
+    //     message: 'Please provide SMTP username',
+    // },
+    // {
+    //     type: 'password',
+    //     name: 'solidApiEmailPassword',
+    //     message: 'Please provide SMTP password',
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiEmailHost',
+    //     message: 'Please provide SMTP host',
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiEmailPort',
+    //     message: 'Please provide SMTP port',
+    //     default: '587',
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiEmailFrom',
+    //     message: 'Please provide your default from email address',
+    // },
+// 10.  Choose your default SMS provider i.e MSG91
+//         - Please provide SMS API url
+//         - Please provide SMS API key
+    // {
+    //     type: 'list',
+    //     name: 'solidApiSmsProvider',
+    //     message: 'Choose your default SMS provider',
+    //     choices: ['MSG91', 'Twilio'],
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiSmsApiUrl',
+    //     message: 'Please provide SMS API url',
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiSmsApiKey',
+    //     message: 'Please provide SMS API key',
+    // },
+// 11. Do you want to enable Whatsapp i.e default no
+//     - Choose your default Whatsapp provider i.e MSG91
+//         - Please provide your api key
+//         - Please provide your whatsapp integrated number
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableWhatsapp',
+    //     message: 'Do you want to enable Whatsapp?',
+    //     default: false,
+    // },
+// 12. Do you want to enable link shortener i.e default no
+//     - Choose your default link shortner service i.e tinyurl
+//         - Please provide your api url
+//         - Please provide your api key
+//         - Please provide your short url domain
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableLinkShortener',
+    //     message: 'Do you want to enable link shortener?',
+    //     default: false,
+    // },
+// 13. Do you want to enable oauth i.e default no ??
+//     - Choose your default oauth provider i.e google
+//         - Please provide your client id
+//         - Please provide your client secret
+    // {
+    //     type: 'confirm',
+    //     name: 'solidApiEnableOauth',
+    //     message: 'Do you want to enable oauth?',
+    //     default: false,
+    // },
+    // {
+    //     type: 'list',
+    //     name: 'solidApiOauthProvider',
+    //     message: 'Choose your default oauth provider',
+    //     choices: ['google', 'facebook'],
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiOauthClientId',
+    //     message: 'Please provide your client id',
+    // },
+    // {
+    //     type: 'input',
+    //     name: 'solidApiOauthClientSecret',
+    //     message: 'Please provide your client secret',
+    // }
+    // Choose your frontend app portname
+    {
+        type: 'input',
+        name: 'solidUiPort',
+        message: 'Choose your frontend app port',
+        default: '3001',
+    }
+];

package/templates/dot.templates/dot.vscode.template/launch.json

@@ -0,0 +1,29 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Debug solid-api Nest Framework",
+            "args": [
+              "${workspaceFolder}/solid-api/src/main.ts"
+            ],
+            "runtimeArgs": [
+              "--nolazy",
+              "-r",
+              "ts-node/register",
+              "-r",
+              "tsconfig-paths/register"
+            ],
+            "sourceMaps": true,
+            "envFile": "${workspaceFolder}/solid-api/.env",
+            "cwd": "${workspaceFolder}/solid-api",
+            "console": "integratedTerminal",
+            "runtimeExecutable": "node",
+            "autoAttachChildProcesses": true
+          },
+    ]
+}

package/templates/nest-template/README.md

@@ -0,0 +1,73 @@
+<p align="center">
+  <a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo" /></a>
+</p>
+
+[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
+[circleci-url]: https://circleci.com/gh/nestjs/nest
+
+  <p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
+    <p align="center">
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
+<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
+<a href="https://coveralls.io/github/nestjs/nest?branch=master" target="_blank"><img src="https://coveralls.io/repos/github/nestjs/nest/badge.svg?branch=master#9" alt="Coverage" /></a>
+<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
+<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
+<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
+  <a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg"/></a>
+    <a href="https://opencollective.com/nest#sponsor"  target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
+  <a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow"></a>
+</p>
+  <!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
+  [![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->
+
+## Description
+
+[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.
+
+## Installation
+
+```bash
+$ npm install
+```
+
+## Running the app
+
+```bash
+# development
+$ npm run start
+
+# watch mode
+$ npm run start:dev
+
+# production mode
+$ npm run start:prod
+```
+
+## Test
+
+```bash
+# unit tests
+$ npm run test
+
+# e2e tests
+$ npm run test:e2e
+
+# test coverage
+$ npm run test:cov
+```
+
+## Support
+
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+
+## Stay in touch
+
+- Author - [Kamil Myśliwiec](https://kamilmysliwiec.com)
+- Website - [https://nestjs.com](https://nestjs.com/)
+- Twitter - [@nestframework](https://twitter.com/nestframework)
+
+## License
+
+Nest is [MIT licensed](LICENSE).