@ramme-io/create-app 1.0.4 → 1.1.1

package/README.md

@@ -2,17 +2,17 @@
 
 [![NPM Version](https://img.shields.io/npm/v/@ramme-io/create-app.svg)](https://www.npmjs.com/package/@ramme-io/create-app) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-**The clean-room environment for modern product design.**
+**A quick start for prototypes.**
 
-This repository is the official scaffolding tool for the Ramme ecosystem. It automates the setup of a production-grade frontend environment, pre-wiring the **Ramme UI** component library with the industry's most robust open-source technologies.
+This repository is the scaffolding tool for the Ramme collection. It spins up a standard frontend environment, with the **Ramme UI** component library included.
 
-Designed for speed and structural integrity, this starter kit removes the friction of configuration so you can move from concept to interactive prototype in seconds.
+Designed for quick builds, this starter kit standardizes configurations so you can move from concept to interactive prototype in seconds.
 
 ---
 
 ## Quick Start
 
-To scaffold a new project, run the initialization command in your terminal. This will generate a fresh directory with all dependencies linked and configured.
+To spin up a new project, run the initialization command in your terminal. This will generate a new folder with all resources linked and configured.
 
 *(Replace `my-new-project` with your desired folder name).*
 
@@ -24,11 +24,11 @@ This single command will:
 1.  **Scaffold** a high-performance Vite project structure.
 2.  **Install** React 19, TypeScript, and Tailwind CSS.
 3.  **Configure** the `@ramme-io/ui` component library and design tokens.
-4.  **Optimize** linting and build settings for immediate deployment.
+4.  **Optimize** limited configuration for customization.
 
 ---
 
-## Launch Sequence
+## Getting Started
 
 Once the scaffolding is complete, initialize your local environment:
 
@@ -43,18 +43,18 @@ pnpm install
 # or npm install
 ```
 
-**3. Ignite the dev server**
+**3. Start the dev server**
 ```bash
 pnpm run dev
 ```
 
-Your prototype is now live at `http://localhost:5173`.
+Your prototype is now running locally at `http://localhost:5173`.
 
 ---
 
 ## The Tech Stack
 
-This starter kit is not a proprietary framework; it is an opinionated orchestration of the best open-source tools available:
+This starter kit is an opinionated selection of the best open-source tools available:
 
 * **Vite:** Next-generation tooling for instant server start and lightning-fast HMR (Hot Module Replacement).
 * **React:** The standard library for building composable user interfaces.
@@ -64,12 +64,10 @@ This starter kit is not a proprietary framework; it is an opinionated orchestrat
 
 ---
 
-## The Ramme Ecosystem
-
-This tool is part of a suite of developer resources maintained by **Excesspool Limited Liability Company**:
+## Project Links
 
 * **`@ramme-io/ui`**: The core library of visual primitives.
-* **`@ramme-io/create-app`** (This Repository): The CLI scaffolding tool.
+* **`@ramme-io/create-app`** (This Repository): The quick start kit.
 
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ramme-io/create-app",
-  "version": "1.0.4",
+  "version": "1.1.1",
   "type": "module",
   "bin": {
     "create-ramme-app": "./index.js"
@@ -16,7 +16,7 @@
     "pack-tarball": "npm pack"
   },
   "dependencies": {
-    "@ramme-io/ui": "^0.0.1",
+    "@ramme-io/ui": "^1.1.0",
     "ag-grid-community": "^34.1.2",
     "ag-grid-enterprise": "^34.1.2",
     "ag-grid-react": "^34.1.2",

package/template/DESIGNER_GUIDE.md

@@ -1,57 +1,77 @@
-# DESIGNER_GUIDE.md
+# Ramme App Starter
 
-## 1. What is the Ramme App Starter?
+[![NPM Version](https://img.shields.io/npm/v/@ramme-io/create-app.svg)](https://www.npmjs.com/package/@ramme-io/create-app) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-Welcome to the Ramme App Starter! Think of this as your pre-built, fully-wired canvas for creating interactive prototypes. It's designed specifically for product designers, founders, and creators who want to build and test high-fidelity ideas without getting stuck on complex technical setup.
+**A quick start for prototypes.**
 
-The starter kit comes with our entire `@ramme-io/ui` component library, a dynamic theming system, and a modern development environment already configured. This lets you skip the tedious setup and jump straight into bringing your vision to life.
+This repository is the scaffolding tool for the Ramme collection. It spins up a standard frontend environment, with the **Ramme UI** component library included.
 
-## 2. Before You Start: Prerequisites
+Designed for quick builds, this starter kit standardizes configurations so you can move from concept to interactive prototype in seconds.
 
-You only need two things on your computer to get started:
+---
 
-* **Node.js**: This is the underlying engine that runs the development environment. You can download the latest "LTS" (Long-Term Support) version from the official [Node.js website](https://nodejs.org/).
-* **A Code Editor**: We highly recommend using [Visual Studio Code](https://code.visualstudio.com/), as it's free and has excellent support for the technologies in this project.
+## Quick Start
 
-## 3. The One-Command Setup (Sub-5-Minute Goal ⏱️)
+To spin up a new project, run the initialization command in your terminal. This will generate a new folder with all resources linked and configured.
 
-Our primary goal is to get you from zero to a running prototype in under five minutes. The entire setup process is handled by a single command.
+*(Replace `my-new-project` with your desired folder name).*
 
-Open your computer's terminal (on Mac, you can search for "Terminal"; on Windows, "PowerShell" or "Command Prompt"), and run the following command:
+```bash
+npm create @ramme-io/app@latest my-new-project
+```
+
+This single command will:
+1.  **Scaffold** a high-performance Vite project structure.
+2.  **Install** React 19, TypeScript, and Tailwind CSS.
+3.  **Configure** the `@ramme-io/ui` component library and design tokens.
+4.  **Optimize** limited configuration for customization.
+
+---
+
+## Getting Started
 
+Once the scaffolding is complete, initialize your local environment:
+
+**1. Enter the project directory**
 ```bash
-npm create @ramme-io/app@latest your-project-name
+cd my-new-project
 ```
 
-This command will ask you for a project name (e.g., `my-new-prototype`). It will then automatically:
+**2. Install dependencies**
+```bash
+pnpm install
+# or npm install
+```
 
-1.  Create a new folder with your project's name.
-2.  Install all the necessary dependencies, including React and `@ramme-io/ui`.
-3.  Set up all the required configuration files.
+**3. Start the dev server**
+```bash
+pnpm run dev
+```
 
-## 4. Running Your Prototype
+Your prototype is now running locally at `http://localhost:5173`.
 
-Once the installation is complete, navigate into your new project directory and start the development server.
+---
 
-`cd <your-project-name>`
-`npm run dev`
+## The Tech Stack
 
-Your new Ramme application will now be running at [http://localhost:5173](http://localhost:5173). Open this link in your web browser, and you will see the interactive style guide.
+This starter kit is an opinionated selection of the best open-source tools available:
 
-## 5. Exploring the Application
+* **Vite:** Next-generation tooling for instant server start and lightning-fast HMR (Hot Module Replacement).
+* **React:** The standard library for building composable user interfaces.
+* **TypeScript:** Statically typed JavaScript for scalable, robust application logic.
+* **Tailwind CSS:** A utility-first styling engine configured with Ramme design tokens.
+* **@ramme-io/ui:** A pre-installed suite of accessible, unstyled primitives based on Radix UI.
 
-The application that's running is a complete, interactive prototype that also serves as a style guide for the `@ramme-io/ui` component library.
+---
 
-* **Live Components**: Every component you see is a live, interactive example. You can click buttons, open menus, and interact with forms to see exactly how they look and feel.
-* **Side Navigation**: Use the navigation on the left to jump between different pages and categories of components.
-* **Dynamic Theming**: Use the user menu in the top-right header to switch between themes and see how all components instantly adapt to different visual styles (like Dark Mode).
-* **Multi-Template System**: Use the "Dashboard | Docs" toggle in the header to switch between two different application layouts. Notice how the content stays the same, but the entire navigation structure changes.
+## Project Links
 
-## 6. The Power of the Sitemap: Your First Change
+* **`@ramme-io/ui`**: The core library of visual primitives.
+* **`@ramme-io/create-app`** (This Repository): The quick start kit.
 
-The single most powerful feature of the Ramme starter is that the application's entire structure—its pages, navigation, titles, and icons—is controlled by a single file called a **sitemap**.
+---
 
-This is your central control panel. You don't need to hunt through component files to change a page title or reorder a navigation item. Let's try it.
+## License
 
-1.  **Open the Project in Your Code Editor**: Open the folder you created (e.g., `my-new-prototype`) in VS Code.
-2.  **Find the Sitemap**: In the file explorer on the left, navigate to `src` > `templates` > `dashboard` and open the `dashboard.sitemap.ts
+Copyright © 2025 Excesspool Limited Liability Company.
+This project is licensed under the [MIT License](LICENSE).

package/template/README.md

@@ -2,81 +2,76 @@
 
 [![NPM Version](https://img.shields.io/npm/v/@ramme-io/create-app.svg)](https://www.npmjs.com/package/@ramme-io/create-app) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-This repository is the official starter kit for building applications with the **Ramme UI** component library. It provides the ideal local environment for designers and developers to rapidly build, test, and validate high-fidelity, interactive prototypes.
+**A quick start for prototypes.**
 
-The starter kit comes pre-configured with a modern frontend stack to ensure a smooth development experience, allowing you to focus on building your application instead of on project setup.
+This repository is the scaffolding tool for the Ramme collection. It spins up a standard frontend environment, with the **Ramme UI** component library included.
+
+Designed for quick builds, this starter kit standardizes configurations so you can move from concept to interactive prototype in seconds.
 
 ---
 
-## Getting Started
+## Quick Start
 
-To create a new project using this starter kit, run the following command in your terminal. This will scaffold a new application in a directory of your choice.
+To spin up a new project, run the initialization command in your terminal. This will generate a new folder with all resources linked and configured.
 
-*(Replace `your-project-name` with the actual name you want for your folder).*
+*(Replace `my-new-project` with your desired folder name).*
 
 ```bash
-npm create @ramme-io/app@latest your-project-name
+npm create @ramme-io/app@latest my-new-project
 ```
 
 This single command will:
+1.  **Scaffold** a high-performance Vite project structure.
+2.  **Install** React 19, TypeScript, and Tailwind CSS.
+3.  **Configure** the `@ramme-io/ui` component library and design tokens.
+4.  **Optimize** limited configuration for customization.
 
-- Create a new project folder.
-
-- Install all necessary dependencies, including React, Vite, and @ramme-io/ui.
-
-- Set up the recommended folder structure and configuration files.
-
-##Post-Installation Steps
+---
 
-After the installation is complete, follow these 3 steps to launch your app:
+## Getting Started
 
-# 1. Navigate into your new project
+Once the scaffolding is complete, initialize your local environment:
 
+**1. Enter the project directory**
 ```bash
-cd your-project-name
+cd my-new-project
 ```
-# 2. Install dependencies
 
+**2. Install dependencies**
 ```bash
 pnpm install
+# or npm install
 ```
-# 3. Start the development server
 
+**3. Start the dev server**
 ```bash
 pnpm run dev
 ```
 
-Your new Ramme application will be running at [http://localhost:5173](http://localhost:5173)
+Your prototype is now running locally at `http://localhost:5173`.
 
 ---
 
-## What's Included?
-This starter kit is built on a modern, performant tech stack:
+## The Tech Stack
 
-* **Vite:** A next-generation frontend tooling that provides an extremely fast development server and build process.
+This starter kit is an opinionated selection of the best open-source tools available:
 
-* **React:** A JavaScript library for building user interfaces.
-
-* **TypeScript:** A statically typed superset of JavaScript that adds type safety to your code.
-
-* **Tailwind CSS:** A utility-first CSS framework for rapid UI development.
-
-* **@ramme-io/ui:** Our own designer-centric component library, pre-installed and ready to use.
+* **Vite:** Next-generation tooling for instant server start and lightning-fast HMR (Hot Module Replacement).
+* **React:** The standard library for building composable user interfaces.
+* **TypeScript:** Statically typed JavaScript for scalable, robust application logic.
+* **Tailwind CSS:** A utility-first styling engine configured with Ramme design tokens.
+* **@ramme-io/ui:** A pre-installed suite of accessible, unstyled primitives based on Radix UI.
 
 ---
 
-## The Ramme Ecosystem
-The Ramme project is an integrated framework architected across three separate repositories:
+## Project Links
 
-* `@ramme-io/ui` A public, open-source component library distributed as an NPM package.
-
-* `ramme-app-starter` (This Repository): A public, open-source starter-kit application that provides the ideal local environment for building with Ramme.
-
-* `ramme-app-builder` A hosted SaaS application featuring our AI Prototyping Assistant, which guides users through the strategic A.D.A.P.T. Framework to build applications from a solid strategic foundation.
+* **`@ramme-io/ui`**: The core library of visual primitives.
+* **`@ramme-io/create-app`** (This Repository): The quick start kit.
 
 ---
 
 ## License
-This project is licensed under the MIT License.
-
 
+Copyright © 2025 Excesspool Limited Liability Company.
+This project is licensed under the [MIT License](LICENSE).

package/template/pkg.json

@@ -9,7 +9,7 @@
     "preview": "vite preview"
   },
   "dependencies": {
-    "@ramme-io/ui": "^0.0.1",
+    "@ramme-io/ui": "^1.1.0",
     "ag-grid-community": "^31.3.1",
     "ag-grid-enterprise": "^31.3.1",  
     "ag-grid-react": "^31.3.1",