Merge pull request #93 from js-template/top-bar-backend-components-1x

Top bar backend components 1x

Author: zelal-dev

docs/docs/.gitignore

@@ -0,0 +1 @@
+.vercel

docs/docs/package.json

@@ -1,14 +1,14 @@
 {
-  "name": "docs",
+  "name": "@padmadev/docs",
   "version": "1.0.0",
   "private": true,
   "scripts": {
-    "dev": "next",
+    "dev": "next dev",
     "start": "next start",
     "build": "next build",
     "export": "next export"
   },
-  "author": "Shu Ding",
+  "author": "Zelal",
   "license": "MIT",
   "dependencies": {
     "clsx": "^1.2.1",

docs/docs/pages/_meta.json

@@ -1,35 +1,32 @@
 {
   "index": {
     "title": "Welcome to Padma",
+    "display": "hidden",
+    "type": "page",
     "theme": {
-      "toc": true
+      "layout": "full"
     }
   },
-  "get-started": {
-    "title": "Get Started"
-  },
-  "core-concepts": {
-    "title": "Core Concepts",
-    "theme": {
-      "toc": true
-    }
-  },
-  "guides": {
-    "title": "User Guides",
+  "user-docs": {
+    "title": "Documentation",
+    "type": "page",
     "theme": {
-      "toc": true
+      "layout": "full"
     }
   },
-  "deployment": {
-    "title": "Deployment",
+
+  "cli-docs": {
+    "title": "Padma CLI Docs",
+    "type": "page",
     "theme": {
-      "toc": true
+      "layout": "full"
     }
   },
-  "contribution-guide": {
-    "title": "Contribution Guide",
+  "plugins": {
+    "title": "Plugins",
+    "type": "page",
     "theme": {
-      "toc": true
+      "layout": "full"
     }
   }
 }

docs/docs/pages/cli-docs/_meta.json

@@ -0,0 +1,26 @@
+{
+  "intro": {
+    "title": "Introduction",
+    "theme": {
+      "toc": true
+    }
+  },
+  "commands": {
+    "title": "CLI Commands",
+    "theme": {
+      "toc": true
+    }
+  },
+  "packages": {
+    "title": "Packages",
+    "theme": {
+      "toc": true
+    }
+  },
+  "strapi plugin": {
+    "title": "Strapi Plugin",
+    "theme": {
+      "toc": true
+    }
+  }
+}

docs/docs/pages/cli-docs/commands/_meta.json

@@ -0,0 +1,26 @@
+{
+  "index": {
+    "title": "Create",
+    "theme": {
+      "toc": true
+    }
+  },
+  "generate": {
+    "title": "Generate",
+    "theme": {
+      "toc": true
+    }
+  },
+  "dev": {
+    "title": "Dev",
+    "theme": {
+      "toc": true
+    }
+  },
+  "build": {
+    "title": "Build",
+    "theme": {
+      "toc": true
+    }
+  }
+}

docs/docs/pages/cli-docs/commands/build.mdx

@@ -0,0 +1,2 @@
+
+### --- Docs are in progress ---

docs/docs/pages/cli-docs/commands/dev.mdx

@@ -0,0 +1,45 @@
+
+# Development Command
+
+## Overview
+The `dev` command starts the development server for the `@padmadev/core` package. It validates the project setup and uses the appropriate package manager to run the development server in the `core` folder.
+
+## **Usage**
+Run the following command:
+
+```bash
+npx padma dev
+```
+
+
+## **Command Behavior**
+1. **Verify Settings File**  
+   - Ensures `padma.settings.json` exists in the project root.
+   - Validates that the file defines an `activeTheme`.
+
+2. **Validate Core Directory**  
+   - Confirms the `core` folder exists.
+   - Suggests running `npx padma generate core` if the folder is missing.
+
+3. **Detect Package Manager**  
+   - Detects the package manager based on the presence of lock files:
+     - `yarn.lock` → Yarn
+     - `pnpm-lock.yaml` → pnpm
+     - `package-lock.json` → npm
+
+4. **Run the Dev Command**  
+   - Executes the corresponding `dev` script:
+     - `yarn dev`, `pnpm dev`, or `npm run dev`.
+
+---
+
+## **Example Output**
+
+### Successful Start
+```plaintext
+Running "npm run dev" in /path/to/project/core
+> core@0.1.0 dev /path/to/project/core
+> nodemon index.js
+Development server running at http://localhost:3000
+```
+---

docs/docs/pages/cli-docs/commands/generate.mdx

@@ -0,0 +1,72 @@
+
+# Generate Command
+
+## Overview
+The `generate` command in the Padma CLI allows you to quickly create predefined folders and templates to streamline project setup and development. Two main subcommands are available: `core` and `theme`.
+
+| Subcommand | Description                    | Flags                     |
+|------------|--------------------------------|---------------------------|
+| `core`     | Generates the core folder.    | None                      |
+| `theme`    | Generates a theme folder.     | `--name` / `-n`           |
+
+
+
+### **Generate Core**
+The `core` command generates the core folder in the current project. It copies the necessary files and templates from the predefined core template directory.
+
+#### **Usage**
+Run the following command:
+
+```bash
+npx padma generate core
+```
+
+#### **Description**
+- This command will:
+  - Copy the core template files into a folder named `core` in the current directory.
+  - Ensure that the core folder doesn’t already exist to prevent overwriting files.
+  - Log success or error messages for user feedback.
+
+#### **Example Output**
+```plaintext
+Generating "core"...
+Template folder: /path/to/templates/core
+Target folder: /path/to/current-project/core
+Successfully generated "core".
+```
+
+
+### **Generate Theme**
+The `theme` command generates a customizable theme folder inside the `packages` directory of your project.
+
+#### **Usage**
+Run the following command:
+
+```bash
+npx padma generate theme --name custom-theme
+```
+
+#### **Flags**
+- **`--name` | `-n`**: Specifies the name of the theme.  
+  Default: `custom-theme`
+
+#### **Description**
+- This command will:
+  - Copy the theme template files into a folder named after the specified theme.
+  - Place the theme folder inside the `packages` directory.
+  - Log success or error messages for user feedback.
+
+#### **Example**
+```bash
+npx padma generate theme --name awesome-theme
+```
+
+#### **Example Output**
+```plaintext
+Generating theme "awesome-theme"...
+Template folder: /path/to/templates/theme
+Target folder: /path/to/current-project/packages/awesome-theme
+Theme generation successful! Run your theme from "packages/awesome-theme".
+```
+
+---

docs/docs/pages/cli-docs/commands/index.mdx

@@ -0,0 +1,62 @@
+
+# Create Command
+
+## Description
+The `create` command in the Padma CLI is used to set up a new Padma project with minimal effort. It includes prompts for selecting configuration options and initializes a project with all necessary files.
+
+
+## Usage
+
+Run the following command to create a new Padma project:
+
+```bash
+npx padma create <project-name>
+```
+
+For example:
+
+```bash
+npx padma create my-project
+```
+
+---
+
+## Flags
+
+- **`--force` | `-f`**:  
+  Forces the creation of the project even if the target folder already exists.  
+  Example:  
+  ```bash
+  npx padma create my-project
+  ```
+
+- **`--theme` | `-t`**:  
+  Installs a specific theme during project setup.  
+  Example:  
+  ```bash
+  npx padma create my-project --theme blank-theme
+  ```
+
+---
+
+## Step-by-Step Guide
+
+### 1. Select a Package Manager  
+During the setup process, you will be prompted to select your preferred package manager. Available options include `npm`, `yarn`, and `pnpm`. If you're unsure, you can select the default one.
+
+**Example Prompt**:  
+```plaintext
+? Which package manager would you like to use? (npm, yarn, pnpm)
+```
+
+### 2. Initialize Git (Optional)  
+You will be asked if you'd like to initialize a Git repository for your project. If you select "Yes," the CLI will automatically set up a Git repository, add all files, and make the initial commit.
+
+**Example Prompt**:  
+```plaintext
+? Would you like to initialize a Git repository? (y/n)
+```
+
+---
+
+

docs/docs/pages/cli-docs/intro.mdx

@@ -0,0 +1,54 @@
+
+# CLI Commands
+API reference of Padma CLI commands.
+
+The Padma command-line tool (CLI) is the main entry point for creating and managing Padma projects. It provides functionality such as running a development server, generating templates, or building your application for deployment.
+
+## How to Use Padma CLI
+The Padma CLI commands are available via npm. You can run any Padma command by using:
+
+```bash
+npx padma <padma-command>
+```
+
+Run `npx padma --help` for full help and a list of available commands.
+
+---
+
+## Commands
+
+### [Create Commands](/cli-docs/commands/)
+These commands allow you to create Padma projects or packages:
+
+- **create**  
+  Initializes a new Padma project.
+
+---
+
+### [Generate Commands](/cli-docs/commands/generate/)
+These commands allow you to create Padma projects or packages:
+
+- **generate core**  
+  Generates the core folder structure in your project.
+
+- **generate theme [theme-name]**  
+  Generates a theme folder inside the `packages` directory. If no theme name is provided, it defaults to `custom-theme`.
+
+---
+
+### [Dev Commands](cli-docs/commands/dev)
+These commands allow you to run a Padma project in development or production mode:
+
+- **dev**  
+  Starts a development server for your Padma application.
+
+- **serve**  
+  Serves a built Padma application in production mode.
+
+---
+
+### [Build Commands](build-commands)
+These commands allow you to build or analyze your Padma project:
+
+- **build**  
+  Generates production-ready code for deployment.