create-rakta-app 0.1.0
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 +101 -0
- package/dist/index.js +4094 -0
- package/dist/index.js.map +23 -0
- package/package.json +65 -0
package/README.md
ADDED
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# create-rakta-app
|
|
2
|
+
|
|
3
|
+
The official project generator for **Rakta.js**.
|
|
4
|
+
|
|
5
|
+
> Small in size. Fierce in speed. Alive in every route.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bun create rakta-app@latest my-app
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Other package managers:
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bunx create-rakta-app@latest my-app
|
|
17
|
+
npm create rakta-app@latest my-app
|
|
18
|
+
npm exec create-rakta-app@latest my-app
|
|
19
|
+
pnpm create rakta-app@latest my-app
|
|
20
|
+
pnpm dlx create-rakta-app@latest my-app
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
> Note: `npm create-rakta-app@latest my-app` (without the space before
|
|
24
|
+
> `rakta-app`) is **not** valid npm initializer syntax. The correct form
|
|
25
|
+
> is `npm create rakta-app@latest my-app` — npm's `create` command always
|
|
26
|
+
> expects the package name as a separate argument after stripping the
|
|
27
|
+
> `create-` prefix.
|
|
28
|
+
|
|
29
|
+
## What it asks you
|
|
30
|
+
|
|
31
|
+
1. **Project name**
|
|
32
|
+
2. **Project mode** — Frontend only, or Fullstack
|
|
33
|
+
3. **CSS framework** — Tailwind CSS v4 (default), Bootstrap, SASS, or none
|
|
34
|
+
4. **Rendering mode** — CSR, SSR, SSG, CSG, SPA, or Hybrid
|
|
35
|
+
5. *(Fullstack only)* **Backend framework** — Gaman.js, Express.js, Nest.js, or Adonis.js
|
|
36
|
+
6. *(Fullstack only)* **Database** — PostgreSQL, MySQL, MongoDB, Firebase, SQLite, MariaDB, Redis, PlanetScale, Neon, or Turso
|
|
37
|
+
|
|
38
|
+
## Frontend-only output
|
|
39
|
+
|
|
40
|
+
```txt
|
|
41
|
+
my-app/
|
|
42
|
+
├─ app/
|
|
43
|
+
│ ├─ layout.tsx
|
|
44
|
+
│ ├─ page.tsx
|
|
45
|
+
│ ├─ loading.tsx
|
|
46
|
+
│ ├─ error.tsx
|
|
47
|
+
│ ├─ notFound.tsx
|
|
48
|
+
│ └─ components/
|
|
49
|
+
│ ├─ raktaShrimpMascot.tsx
|
|
50
|
+
│ └─ shrimpRunGame.tsx
|
|
51
|
+
├─ public/
|
|
52
|
+
├─ styles/
|
|
53
|
+
│ └─ globals.css
|
|
54
|
+
├─ rakta.config.ts
|
|
55
|
+
├─ rakta-env.d.ts
|
|
56
|
+
├─ package.json
|
|
57
|
+
└─ tsconfig.json
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
No `backend/`, `database/`, `schema/`, `prisma/`, or shared backend files
|
|
61
|
+
are generated in this mode.
|
|
62
|
+
|
|
63
|
+
## Fullstack output
|
|
64
|
+
|
|
65
|
+
```txt
|
|
66
|
+
my-app/
|
|
67
|
+
├─ frontend/
|
|
68
|
+
├─ backend/
|
|
69
|
+
├─ shared/
|
|
70
|
+
├─ docs/
|
|
71
|
+
├─ package.json
|
|
72
|
+
└─ tsconfig.base.json
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
The contents of `backend/` depend on the backend framework you chose —
|
|
76
|
+
Gaman.js, Express.js, Nest.js, and Adonis.js each get a different,
|
|
77
|
+
idiomatic folder structure rather than one generic shape forced onto all
|
|
78
|
+
four.
|
|
79
|
+
|
|
80
|
+
## After generation
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
cd my-app
|
|
84
|
+
bun install
|
|
85
|
+
bun run dev
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
For fullstack apps, the frontend and backend run as separate workspace
|
|
89
|
+
packages — see the generated root `README.md` for the exact dev commands
|
|
90
|
+
for your chosen stack.
|
|
91
|
+
|
|
92
|
+
## Documentation
|
|
93
|
+
|
|
94
|
+
See [`docs/en/templates.md`](../../docs/en/templates.md) /
|
|
95
|
+
[`docs/id/templates.md`](../../docs/id/templates.md) for a full breakdown
|
|
96
|
+
of every template, and [`docs/en/backendFrameworks.md`](../../docs/en/backendFrameworks.md)
|
|
97
|
+
for backend-specific architecture notes.
|
|
98
|
+
|
|
99
|
+
## License
|
|
100
|
+
|
|
101
|
+
MIT — Rhein Sullivan | Vyagra Nexus™
|