create-manifest 1.2.0 → 1.3.0

package/assets/monorepo/README.md

@@ -0,0 +1,51 @@
+<br>
+<p align="center">
+  <a href="https://manifest.build/#gh-light-mode-only">
+    <img alt="manifest" src="https://manifest.build/assets/images/logo-transparent.svg" height="55px" alt="Manifest logo" title="Manifest - A backend so simple that it fits in a YAML file" />
+  </a>
+  <a href="https://manifest.build/#gh-dark-mode-only">
+    <img alt="manifest" src="https://manifest.build/assets/images/logo-light.svg" height="55px" alt="Manifest logo" title="Manifest - A backend so simple that it fits in a YAML file" />
+  </a>
+</p>
+
+<p align='center'>
+<strong>The backend for AI code editors</strong> <br> <span>Manifest is a backend your AI can understand and your team can trust.</span>
+
+## Description
+
+Welcome to your [Manifest](https://github.com/mnfst/manifest) project ! Feel free to replace this README by your own.
+
+This application is a **monorepo** composed by a [Manifest backend](https://github.com/mnfst/manifest) in the "/api" folder and a frontend of your choice that you can add in the "/web" folder.
+
+## Installation
+
+```bash
+$ npm install
+```
+
+## Running the app
+
+To run the app in the development mode:
+
+```bash
+npm run start
+```
+
+- Open [http://localhost:1111](http://localhost:1111) to open your admin UI it in your browser
+- Open [http://localhost:1111/api](http://localhost:111/api) to view your REST API documentation
+
+The page will reload when you make changes.
+
+## Seed dummy data
+
+Seeds some dummy data for your entities:
+
+```bash
+npm run seed
+```
+
+## Community & Resources
+
+- [Docs](https://manifest.build/docs) - Get started with Manifest
+- [Discord](https://discord.gg/FepAked3W7) - Come chat with the community
+- [Github](https://github.com/mnfst/manifest/issues) - Report bugs and share ideas to improve the product.

package/assets/monorepo/api-package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@PROJECT_NAME/api",
+  "version": "0.1.0",
+  "description": "A backend made with Manifest: https://manifest.build",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {},
+  "dependencies": {}
+}

package/assets/monorepo/api-readme.md

@@ -0,0 +1,49 @@
+<br>
+<p align="center">
+  <a href="https://manifest.build/#gh-light-mode-only">
+    <img alt="manifest" src="https://manifest.build/assets/images/logo-transparent.svg" height="55px" alt="Manifest logo" title="Manifest - A backend so simple that it fits in a YAML file" />
+  </a>
+  <a href="https://manifest.build/#gh-dark-mode-only">
+    <img alt="manifest" src="https://manifest.build/assets/images/logo-light.svg" height="55px" alt="Manifest logo" title="Manifest - A backend so simple that it fits in a YAML file" />
+  </a>
+</p>
+
+<p align='center'>
+<strong>The backend for AI code editors</strong> <br> <span>Manifest is a backend your AI can understand and your team can trust.</span>
+
+## Description
+
+Welcome to your [Manifest](https://github.com/mnfst/manifest) backend ! Feel free to replace this README by your own.
+
+## Installation
+
+```bash
+$ npm install
+```
+
+## Running the app
+
+To run the app in the development mode:
+
+```bash
+npm run start
+```
+
+- Open [http://localhost:1111](http://localhost:1111) to open your admin UI it in your browser
+- Open [http://localhost:1111/api](http://localhost:111/api) to view your REST API documentation
+
+The page will reload when you make changes.
+
+## Seed dummy data
+
+Seeds some dummy data for your entities:
+
+```bash
+npm run seed
+```
+
+## Community & Resources
+
+- [Docs](https://manifest.build/docs) - Get started with Manifest
+- [Discord](https://discord.gg/FepAked3W7) - Come chat with the community
+- [Github](https://github.com/mnfst/manifest/issues) - Report bugs and share ideas to improve the product.

package/assets/monorepo/root-package.json

@@ -0,0 +1,15 @@
+{
+  "name": "PROJECT_NAME",
+  "private": true,
+  "workspaces": ["api", "web"],
+  "description": "A full-stack app made with Manifest: https://manifest.build",
+  "scripts": {
+    "start": "concurrently \"npm run start:api\" \"npm run start:web\"",
+    "start:api": "npm run start --workspace=api",
+    "start:web": "npm run start --workspace=web",
+    "seed": "npm run seed --workspace=api"
+  },
+  "devDependencies": {
+    "concurrently": "^8.0.0"
+  }
+}

package/assets/monorepo/web-package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@PROJECT_NAME/web",
+  "version": "0.1.0",
+  "private": true,
+  "license": "UNLICENSED",
+  "scripts": {
+    "start": "echo 'Add your frontend framework here'",
+    "build": "echo 'Add your build command here'"
+  }
+}

package/assets/monorepo/web-readme.md

@@ -0,0 +1,9 @@
+# Frontend Application
+
+This folder is ready for your frontend framework of choice:
+
+- Next.js: `npx create-next-app@latest . --typescript --tailwind`
+- Vite React: `npm create vite@latest . -- --template react-ts`
+- SvelteKit: `npm create svelte@latest .`
+
+After setting up your frontend, update the dev script in package.json.

package/assets/{README.md → standalone/README.md}

@@ -26,7 +26,7 @@ $ npm install
 To run the app in the development mode:
 
 ```bash
-npm run manifest
+npm run start
 ```
 
 - Open [http://localhost:1111](http://localhost:1111) to open your admin UI it in your browser
@@ -39,7 +39,7 @@ The page will reload when you make changes.
 Seeds some dummy data for your entities:
 
 ```bash
-npm run manifest:seed
+npm run seed
 ```
 
 ## Community & Resources

package/assets/standalone/manifest.yml

@@ -0,0 +1,34 @@
+# This is a sample file for a manifest.yml manifest backend.
+# Read more about the manifest format here: https:/manifest.build/docs
+
+name: My pet app 🐾
+entities:
+  Owner:
+    properties:
+      - name
+      - { name: birthdate, type: date }
+    policies:
+      read:
+        - access: public
+
+  Cat:
+    properties:
+      - name
+      - { name: age, type: number }
+      - { name: birthdate, type: date }
+    belongsTo:
+      - Owner
+    policies:
+      read:
+        - access: public
+
+  Homepage:
+    nameSingular: Home content
+    single: true
+    properties:
+      - title
+      - { name: description, type: richText }
+      - { name: cover, type: image }
+    policies:
+      read:
+        - access: public

package/dist/commands/index.js

@@ -14,7 +14,7 @@ import { updatePackageJsonFile } from '../utils/UpdatePackageJsonFile.js';
 import { updateSettingsJsonFile } from '../utils/UpdateSettingsJsonFile.js';
 import { getLatestPackageVersion } from '../utils/GetLatestPackageVersion.js';
 import { getBackendFileContent } from '../utils/GetBackendFileContent.js';
-import { input } from '@inquirer/prompts';
+import { input, select } from '@inquirer/prompts';
 import { slugify } from '../utils/helpers.js';
 import chalk from 'chalk';
 const exec = promisify(execCp);
@@ -58,6 +58,7 @@ export default class CreateManifest extends Command {
         // * 1 Create a folder named after the first argument or ask for it.
         const { argv } = await this.parse(CreateManifest);
         let projectName = argv[0];
+        let isMonorepo = argv[1] === 'monorepo';
         if (!projectName) {
             projectName = await input({
                 message: 'What name would you like to use for the new workspace?',
@@ -73,24 +74,53 @@ export default class CreateManifest extends Command {
                 }
             });
         }
+        if (!isMonorepo) {
+            const projectType = await select({
+                message: 'What type of project would you like to develop?',
+                choices: [
+                    {
+                        name: 'A full-stack app (monorepo)',
+                        value: 'monorepo',
+                        description: 'Creates a monorepo with both "web" and "api" folders'
+                    },
+                    {
+                        name: 'A standalone backend',
+                        value: 'standalone',
+                        description: 'Creates a backend-only project'
+                    }
+                ]
+            });
+            isMonorepo = projectType === 'monorepo';
+        }
         projectName = slugify(projectName);
         const spinner = ora(`Creating your Manifest project in ${projectName} folder...`).start();
-        const projectFolderPath = path.join(process.cwd(), projectName);
+        const rootFolderPath = path.join(process.cwd(), projectName);
         // Check if the folder already exists
-        if (fs.existsSync(projectFolderPath)) {
-            spinner.fail(`Error: The "${projectFolderPath}" folder already exists in the current directory. Please find another name.`);
+        if (fs.existsSync(rootFolderPath)) {
+            spinner.fail(`Error: The "${rootFolderPath}" folder already exists in the current directory. Please find another name.`);
             process.exit(1);
         }
-        fs.mkdirSync(projectFolderPath);
+        fs.mkdirSync(rootFolderPath);
+        let projectFolderPath;
+        if (isMonorepo) {
+            // If it's a monorepo, create a folder for the project.
+            projectFolderPath = path.join(rootFolderPath, 'api');
+            fs.mkdirSync(projectFolderPath);
+            fs.mkdirSync(path.join(rootFolderPath, 'web'));
+        }
+        else {
+            // If it's a standalone backend, use the root folder as the project folder.
+            projectFolderPath = rootFolderPath;
+        }
         const manifestFolderName = '.manifest';
         const initialFileName = 'manifest.yml';
         const __dirname = path.dirname(fileURLToPath(import.meta.url));
-        const assetFolderPath = path.join(__dirname, '..', '..', 'assets');
+        const assetFolderPath = path.join(__dirname, '..', '..', 'assets', isMonorepo ? 'monorepo' : 'standalone');
         // * 2. Create a folder with the name `.manifest` for compiled files.
         // Construct the folder path. This example creates the folder in the current working directory.
-        const manifestFolderPath = path.join(projectFolderPath, manifestFolderName);
+        const compiledFolderPath = path.join(projectFolderPath, manifestFolderName);
         // Create the folder
-        fs.mkdirSync(manifestFolderPath);
+        fs.mkdirSync(compiledFolderPath);
         // * 3. Create a file with the name `manifest.yml`.
         const newFilePath = path.join(projectFolderPath, initialFileName);
         // Get the content of the file either remote or local.
@@ -100,18 +130,12 @@ export default class CreateManifest extends Command {
         // Write the content to the new file
         fs.writeFileSync(newFilePath, content);
         spinner.succeed();
-        spinner.start('Updating package.json file...');
+        spinner.start('Creating package.json file...');
         // Update package.json file.
         const packagePath = path.join(projectFolderPath, 'package.json');
-        let packageJson;
-        if (fs.existsSync(packagePath)) {
-            packageJson = parse(fs.readFileSync(packagePath, 'utf8'));
-        }
-        else {
-            packageJson = JSON.parse(fs
-                .readFileSync(path.join(assetFolderPath, 'default-package.json'), 'utf8')
-                .replace('PROJECT_NAME', projectName));
-        }
+        const packageJson = JSON.parse(fs
+            .readFileSync(path.join(assetFolderPath, 'api-package.json'), 'utf8')
+            .replace('PROJECT_NAME', projectName));
         const manifestLatestVersion = await getLatestPackageVersion('manifest');
         fs.writeFileSync(packagePath, updatePackageJsonFile({
             fileContent: packageJson,
@@ -123,10 +147,21 @@ export default class CreateManifest extends Command {
                 seed: 'node node_modules/manifest/dist/manifest/src/seed/scripts/seed.js'
             }
         }));
+        if (isMonorepo) {
+            // If it's a monorepo, also update the web package.json file and the root package.json file.
+            const webPackagePath = path.join(rootFolderPath, 'web', 'package.json');
+            fs.writeFileSync(webPackagePath, fs
+                .readFileSync(path.join(assetFolderPath, 'web-package.json'), 'utf8')
+                .replace('PROJECT_NAME', projectName));
+            const rootPackagePath = path.join(rootFolderPath, 'package.json');
+            fs.writeFileSync(rootPackagePath, fs
+                .readFileSync(path.join(assetFolderPath, 'root-package.json'), 'utf8')
+                .replace('PROJECT_NAME', projectName));
+        }
         spinner.succeed();
         spinner.start('Adding settings...');
         // Update .vscode/extensions.json file.
-        const vscodeDirPath = path.join(projectFolderPath, '.vscode');
+        const vscodeDirPath = path.join(rootFolderPath, '.vscode');
         const extensionsFilePath = path.join(vscodeDirPath, 'extensions.json');
         let extensionsJson;
         //  Ensure the `.vscode` Directory Exists
@@ -172,7 +207,7 @@ export default class CreateManifest extends Command {
             'node_modules',
             '.env',
             'public',
-            'manifest/backend.db' // TODO: Adapt to new folder structure.
+            '.manifest'
         ];
         newGitignoreLines.forEach((line) => {
             if (!gitignoreContent.includes(line)) {
@@ -182,15 +217,22 @@ export default class CreateManifest extends Command {
         fs.writeFileSync(gitignorePath, gitignoreContent);
         spinner.succeed();
         // * 9. Add a README.md file if it doesn't exist.
-        const readmeFilePath = path.join(projectFolderPath, 'README.md');
+        const readmeFilePath = path.join(rootFolderPath, 'README.md');
         if (!fs.existsSync(readmeFilePath)) {
             fs.writeFileSync(readmeFilePath, fs.readFileSync(path.join(assetFolderPath, 'README.md'), 'utf8'));
         }
+        if (isMonorepo) {
+            // If it's a monorepo, create a README.md file in the web folder and api folder (in addition to the root folder).
+            const webReadmeFilePath = path.join(rootFolderPath, 'web', 'README.md');
+            fs.writeFileSync(webReadmeFilePath, fs.readFileSync(path.join(assetFolderPath, 'web-readme.md'), 'utf8'));
+            const apiReadmeFilePath = path.join(rootFolderPath, 'api', 'README.md');
+            fs.writeFileSync(apiReadmeFilePath, fs.readFileSync(path.join(assetFolderPath, 'api-readme.md'), 'utf8'));
+        }
         // * 10. Add optional files based on flags
         // Add rules for IDEs.
         if (flags.cursor) {
             spinner.start('Adding rules for Cursor IDE...');
-            const cursorFolderPath = path.join(projectFolderPath, '.cursor', 'rules');
+            const cursorFolderPath = path.join(rootFolderPath, '.cursor', 'rules');
             const cursorFileName = 'manifest.mdc';
             fs.mkdirSync(cursorFolderPath, { recursive: true });
             let cursorFileContent;
@@ -211,7 +253,7 @@ export default class CreateManifest extends Command {
         }
         if (flags.copilot) {
             spinner.start('Adding rules for Copilot IDE...');
-            const copilotFolderPath = path.join(projectFolderPath, '.github');
+            const copilotFolderPath = path.join(rootFolderPath, '.github');
             const copilotFileName = 'copilot-instructions.md';
             fs.mkdirSync(copilotFolderPath, { recursive: true });
             let copilotFileContent;
@@ -232,7 +274,7 @@ export default class CreateManifest extends Command {
         }
         if (flags.windsurf) {
             spinner.start('Adding rules for WindSurf IDE...');
-            const windsurfFolderPath = path.join(projectFolderPath, '.windsurf', 'rules');
+            const windsurfFolderPath = path.join(rootFolderPath, '.windsurf', 'rules');
             const windsurfFileName = 'manifest.md';
             fs.mkdirSync(windsurfFolderPath, { recursive: true });
             let windsurfFileContent;
@@ -282,7 +324,7 @@ export default class CreateManifest extends Command {
         let serveTask = null;
         try {
             // We run the manifest script to build the database.
-            serveTask = exec(`cd ${projectName} && npm run manifest`);
+            serveTask = exec(`cd ${projectName} && npm run start`);
             await this.waitForServerToBeReady();
             spinner.succeed();
         }
@@ -291,7 +333,7 @@ export default class CreateManifest extends Command {
         }
         spinner.start('Seeding initial data...');
         try {
-            await exec(`cd ${projectName} && npm run manifest:seed`);
+            await exec(`cd ${projectName} && npm run seed`);
         }
         catch (error) {
             spinner.fail(`Execution error: ${error}`);
@@ -303,7 +345,7 @@ export default class CreateManifest extends Command {
         console.log('To start the server:');
         console.log();
         console.log(chalk.bold(`  cd ${projectName}`));
-        console.log(chalk.bold('  npm run manifest'));
+        console.log(chalk.bold('  npm run start'));
         console.log();
         await this.silentKill(serveTask?.child?.pid || 0);
         process.exit();

package/oclif.manifest.json

@@ -43,5 +43,5 @@
       "enableJsonFlag": false
     }
   },
-  "version": "1.2.0"
+  "version": "1.3.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-manifest",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "author": "Manifest",
   "description": "Create a new Manifest backend",
   "homepage": "https://manifest.build",