Skip to content

Commit 95d5957

Browse files
committed
Rename project to quickstart-react and update README references accordingly
1 parent c9ed96f commit 95d5957

File tree

2 files changed

+36
-15
lines changed

2 files changed

+36
-15
lines changed

package.json

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,40 @@
11
{
2-
"name": "quick-react",
2+
"name": "quickstart-react",
33
"version": "1.0.0",
4-
"description": "",
4+
"description": "A CLI tool to quickly scaffold a React + Vite project with optional CSS frameworks and useful packages, ready to use out of the box.",
55
"main": "index.js",
6-
"type": "module",
6+
"type": "module",
77
"scripts": {
8-
"test": "echo \"Error: no test specified\" && exit 1"
8+
"test": "echo \"Error: no test specified\" && exit 1",
9+
"start": "node index.js"
910
},
1011
"bin": {
11-
"quick-react": "index.js"
12+
"quickstart-react": "index.js"
1213
},
13-
"keywords": [],
14-
"author": "",
15-
"license": "ISC",
14+
"keywords": [
15+
"react",
16+
"vite",
17+
"cli",
18+
"scaffolding",
19+
"starter",
20+
"template",
21+
"tailwind",
22+
"bootstrap",
23+
"mui",
24+
"javascript",
25+
"frontend",
26+
"react-app"
27+
],
28+
"author": "Your Name",
29+
"license": "MIT",
30+
"repository": {
31+
"type": "git",
32+
"url": "https://github.com/harshgupta20/quickstart-react.git"
33+
},
34+
"bugs": {
35+
"url": "https://github.com/harshgupta20/quickstart-react/issues"
36+
},
37+
"homepage": "https://github.com/harshgupta20/quickstart-react#readme",
1638
"dependencies": {
1739
"inquirer": "^9.2.7"
1840
}

readme.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# quick-react (React Package Solution)
1+
# quickstart-react (React Package Solution)
22

3-
🚀 **quick-react** is an open-source CLI tool that lets you instantly create a Vite + React app with your choice of CSS framework, optional packages, and pre-configured project structure — all in one command.
3+
🚀 **quickstart-react** is an open-source CLI tool that lets you instantly create a Vite + React app with your choice of CSS framework, optional packages, and pre-configured project structure — all in one command.
44

55
## ✨ Features
66
- **Interactive Setup** — prompts you for project name, CSS framework, and optional packages
@@ -14,18 +14,18 @@
1414
## 📦 Installation
1515
You don’t need to install it globally — run it instantly with `npx`:
1616
```bash
17-
npx quick-react
17+
npx quickstart-react
1818
```
1919

2020
## 🛠 Usage
21-
When you run `npx quick-react`, you will be prompted to:
21+
When you run `npx quickstart-react`, you will be prompted to:
2222
1. **Enter Project Name** — e.g., `my-app`
2323
2. **Choose CSS Framework** — Tailwind, Bootstrap, or MUI
2424
3. **Select Optional Packages** — choose from a list of commonly used React libraries
2525

2626
Example run:
2727
```bash
28-
npx quick-react
28+
npx quickstart-react
2929
```
3030

3131
### Example Walkthrough
@@ -90,7 +90,7 @@ You can add these during setup:
9090

9191
## 🚀 Quick Start
9292
```bash
93-
npx quick-react my-dashboard
93+
npx quickstart-react my-dashboard
9494
```
9595
Select Tailwind, Bootstrap, or MUI, add any packages, and start coding immediately
9696

@@ -106,5 +106,4 @@ Before submitting, please ensure:
106106
- Your code follows project style guidelines
107107
- You have tested your changes locally
108108

109-
110109
#### Happy Hacking 🐱‍🏍

0 commit comments

Comments
 (0)