@ramme-io/create-app 1.0.1 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +33 -36
  3. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Excesspool Limited Liability Company
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -2,81 +2,78 @@
2
2
 
3
3
  [![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)
4
4
 
5
- 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.
5
+ **The clean-room environment for modern product design.**
6
6
 
7
- 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.
7
+ 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.
8
+
9
+ 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.
8
10
 
9
11
  ---
10
12
 
11
- ## Getting Started
13
+ ## Quick Start
12
14
 
13
- 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.
15
+ To scaffold a new project, run the initialization command in your terminal. This will generate a fresh directory with all dependencies linked and configured.
14
16
 
15
- *(Replace `your-project-name` with the actual name you want for your folder).*
17
+ *(Replace `my-new-project` with your desired folder name).*
16
18
 
17
19
  ```bash
18
- npm create @ramme-io/app@latest your-project-name
20
+ npm create @ramme-io/app@latest my-new-project
19
21
  ```
20
22
 
21
23
  This single command will:
24
+ 1. **Scaffold** a high-performance Vite project structure.
25
+ 2. **Install** React 19, TypeScript, and Tailwind CSS.
26
+ 3. **Configure** the `@ramme-io/ui` component library and design tokens.
27
+ 4. **Optimize** linting and build settings for immediate deployment.
22
28
 
23
- - Create a new project folder.
24
-
25
- - Install all necessary dependencies, including React, Vite, and @ramme-io/ui.
26
-
27
- - Set up the recommended folder structure and configuration files.
28
-
29
- ##Post-Installation Steps
29
+ ---
30
30
 
31
- After the installation is complete, follow these 3 steps to launch your app:
31
+ ## Launch Sequence
32
32
 
33
- # 1. Navigate into your new project
33
+ Once the scaffolding is complete, initialize your local environment:
34
34
 
35
+ **1. Enter the project directory**
35
36
  ```bash
36
- cd your-project-name
37
+ cd my-new-project
37
38
  ```
38
- # 2. Install dependencies
39
39
 
40
+ **2. Install dependencies**
40
41
  ```bash
41
42
  pnpm install
43
+ # or npm install
42
44
  ```
43
- # 3. Start the development server
44
45
 
46
+ **3. Ignite the dev server**
45
47
  ```bash
46
48
  pnpm run dev
47
49
  ```
48
50
 
49
- Your new Ramme application will be running at [http://localhost:5173](http://localhost:5173)
51
+ Your prototype is now live at `http://localhost:5173`.
50
52
 
51
53
  ---
52
54
 
53
- ## What's Included?
54
- This starter kit is built on a modern, performant tech stack:
55
+ ## The Tech Stack
55
56
 
56
- * **Vite:** A next-generation frontend tooling that provides an extremely fast development server and build process.
57
+ This starter kit is not a proprietary framework; it is an opinionated orchestration of the best open-source tools available:
57
58
 
58
- * **React:** A JavaScript library for building user interfaces.
59
-
60
- * **TypeScript:** A statically typed superset of JavaScript that adds type safety to your code.
61
-
62
- * **Tailwind CSS:** A utility-first CSS framework for rapid UI development.
63
-
64
- * **@ramme-io/ui:** Our own designer-centric component library, pre-installed and ready to use.
59
+ * **Vite:** Next-generation tooling for instant server start and lightning-fast HMR (Hot Module Replacement).
60
+ * **React:** The standard library for building composable user interfaces.
61
+ * **TypeScript:** Statically typed JavaScript for scalable, robust application logic.
62
+ * **Tailwind CSS:** A utility-first styling engine configured with Ramme design tokens.
63
+ * **@ramme-io/ui:** A pre-installed suite of accessible, unstyled primitives based on Radix UI.
65
64
 
66
65
  ---
67
66
 
68
67
  ## The Ramme Ecosystem
69
- The Ramme project is an integrated framework architected across three separate repositories:
70
68
 
71
- * `@ramme-io/ui` A public, open-source component library distributed as an NPM package.
69
+ This tool is part of a suite of developer resources maintained by **Excesspool Limited Liability Company**:
72
70
 
73
- * `ramme-app-starter` (This Repository): A public, open-source starter-kit application that provides the ideal local environment for building with Ramme.
74
-
75
- * `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.
71
+ * **`@ramme-io/ui`**: The core library of visual primitives.
72
+ * **`@ramme-io/create-app`** (This Repository): The CLI scaffolding tool.
76
73
 
77
74
  ---
78
75
 
79
76
  ## License
80
- This project is licensed under the MIT License.
81
-
82
77
 
78
+ Copyright © 2025 Excesspool Limited Liability Company.
79
+ This project is licensed under the [MIT License](LICENSE).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ramme-io/create-app",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "type": "module",
5
5
  "bin": {
6
6
  "create-ramme-app": "./index.js"