@ramme-io/create-app 1.0.0 → 1.0.2
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.
- package/README.md +33 -36
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,81 +2,78 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@ramme-io/create-app) [](https://opensource.org/licenses/MIT)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
**The clean-room environment for modern product design.**
|
|
6
6
|
|
|
7
|
-
|
|
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
|
-
##
|
|
13
|
+
## Quick Start
|
|
12
14
|
|
|
13
|
-
To
|
|
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 `
|
|
17
|
+
*(Replace `my-new-project` with your desired folder name).*
|
|
16
18
|
|
|
17
19
|
```bash
|
|
18
|
-
npm create @ramme-io/app@latest
|
|
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
|
-
|
|
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
|
-
|
|
31
|
+
## Launch Sequence
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
Once the scaffolding is complete, initialize your local environment:
|
|
34
34
|
|
|
35
|
+
**1. Enter the project directory**
|
|
35
36
|
```bash
|
|
36
|
-
cd
|
|
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
|
|
51
|
+
Your prototype is now live at `http://localhost:5173`.
|
|
50
52
|
|
|
51
53
|
---
|
|
52
54
|
|
|
53
|
-
##
|
|
54
|
-
This starter kit is built on a modern, performant tech stack:
|
|
55
|
+
## The Tech Stack
|
|
55
56
|
|
|
56
|
-
|
|
57
|
+
This starter kit is not a proprietary framework; it is an opinionated orchestration of the best open-source tools available:
|
|
57
58
|
|
|
58
|
-
* **
|
|
59
|
-
|
|
60
|
-
* **TypeScript:**
|
|
61
|
-
|
|
62
|
-
*
|
|
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
|
-
|
|
69
|
+
This tool is part of a suite of developer resources maintained by **Excesspool Limited Liability Company**:
|
|
72
70
|
|
|
73
|
-
*
|
|
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).
|