@ramme-io/create-app 0.0.3 → 0.0.4
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 +11 -5
- package/package.json +1 -1
- package/template/DESIGNER_GUIDE.md +3 -1
- package/template/README.md +10 -4
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Ramme App Starter
|
|
2
2
|
|
|
3
|
-
[](https://opensource.org/licenses/MIT)
|
|
3
|
+
[](https://www.npmjs.com/package/@ramme-io/create-app) [](https://opensource.org/licenses/MIT)
|
|
4
4
|
|
|
5
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.
|
|
6
6
|
|
|
@@ -10,10 +10,12 @@ The starter kit comes pre-configured with a modern frontend stack to ensure a sm
|
|
|
10
10
|
|
|
11
11
|
## Getting Started
|
|
12
12
|
|
|
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.
|
|
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.
|
|
14
|
+
|
|
15
|
+
*(Replace `your-project-name` with the actual name you want for your folder).*
|
|
14
16
|
|
|
15
17
|
```bash
|
|
16
|
-
npm create ramme-app@latest your-project-name
|
|
18
|
+
npm create @ramme-io/app@latest your-project-name
|
|
17
19
|
```
|
|
18
20
|
|
|
19
21
|
This single command will:
|
|
@@ -24,7 +26,9 @@ This single command will:
|
|
|
24
26
|
|
|
25
27
|
- Set up the recommended folder structure and configuration files.
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
##Post-Installation Steps
|
|
30
|
+
|
|
31
|
+
After the installation is complete, follow these 3 steps to launch your app:
|
|
28
32
|
|
|
29
33
|
# 1. Navigate into your new project
|
|
30
34
|
|
|
@@ -73,4 +77,6 @@ The Ramme project is an integrated framework architected across three separate r
|
|
|
73
77
|
---
|
|
74
78
|
|
|
75
79
|
## License
|
|
76
|
-
This project is licensed under the MIT License.
|
|
80
|
+
This project is licensed under the MIT License.
|
|
81
|
+
|
|
82
|
+
|
package/package.json
CHANGED
|
@@ -19,7 +19,9 @@ Our primary goal is to get you from zero to a running prototype in under five mi
|
|
|
19
19
|
|
|
20
20
|
Open your computer's terminal (on Mac, you can search for "Terminal"; on Windows, "PowerShell" or "Command Prompt"), and run the following command:
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
```bash
|
|
23
|
+
npm create @ramme-io/app@latest your-project-name
|
|
24
|
+
```
|
|
23
25
|
|
|
24
26
|
This command will ask you for a project name (e.g., `my-new-prototype`). It will then automatically:
|
|
25
27
|
|
package/template/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Ramme App Starter
|
|
2
2
|
|
|
3
|
-
[](https://opensource.org/licenses/MIT)
|
|
3
|
+
[](https://www.npmjs.com/package/@ramme-io/create-app) [](https://opensource.org/licenses/MIT)
|
|
4
4
|
|
|
5
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.
|
|
6
6
|
|
|
@@ -10,7 +10,9 @@ The starter kit comes pre-configured with a modern frontend stack to ensure a sm
|
|
|
10
10
|
|
|
11
11
|
## Getting Started
|
|
12
12
|
|
|
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.
|
|
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.
|
|
14
|
+
|
|
15
|
+
*(Replace `your-project-name` with the actual name you want for your folder).*
|
|
14
16
|
|
|
15
17
|
```bash
|
|
16
18
|
npm create @ramme-io/app@latest your-project-name
|
|
@@ -24,7 +26,9 @@ This single command will:
|
|
|
24
26
|
|
|
25
27
|
- Set up the recommended folder structure and configuration files.
|
|
26
28
|
|
|
27
|
-
|
|
29
|
+
##Post-Installation Steps
|
|
30
|
+
|
|
31
|
+
After the installation is complete, follow these 3 steps to launch your app:
|
|
28
32
|
|
|
29
33
|
# 1. Navigate into your new project
|
|
30
34
|
|
|
@@ -73,4 +77,6 @@ The Ramme project is an integrated framework architected across three separate r
|
|
|
73
77
|
---
|
|
74
78
|
|
|
75
79
|
## License
|
|
76
|
-
This project is licensed under the MIT License.
|
|
80
|
+
This project is licensed under the MIT License.
|
|
81
|
+
|
|
82
|
+
|