create-rari-app 0.4.4 → 0.4.5
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 +129 -0
- package/package.json +3 -1
- package/templates/default/gitignore +3 -0
package/README.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# create-rari-app
|
|
2
|
+
|
|
3
|
+
> Scaffold a new rari application with zero configuration
|
|
4
|
+
|
|
5
|
+
The fastest way to get started with [rari](https://github.com/rari-build/rari), a high-performance React Server Components framework powered by Rust.
|
|
6
|
+
|
|
7
|
+
## Usage
|
|
8
|
+
|
|
9
|
+
Create a new rari application interactively:
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm create rari-app@latest
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Or specify a project name directly:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
npm create rari-app@latest my-app
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
With other package managers:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
# pnpm
|
|
25
|
+
pnpm create rari-app
|
|
26
|
+
|
|
27
|
+
# yarn
|
|
28
|
+
yarn create rari-app
|
|
29
|
+
|
|
30
|
+
# bun
|
|
31
|
+
bun create rari-app
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## What You Get
|
|
35
|
+
|
|
36
|
+
Running `create-rari-app` sets up a complete rari project with:
|
|
37
|
+
|
|
38
|
+
- **App Router structure** - Pre-configured file-based routing
|
|
39
|
+
- **TypeScript support** - Full type safety out of the box
|
|
40
|
+
- **Development server** - Hot module reloading for instant feedback
|
|
41
|
+
- **Example components** - Server and client component examples
|
|
42
|
+
- **Production ready** - Optimized build configuration included
|
|
43
|
+
|
|
44
|
+
## Project Structure
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
my-app/
|
|
48
|
+
├── app/
|
|
49
|
+
│ ├── layout.tsx # Root layout
|
|
50
|
+
│ ├── page.tsx # Home page
|
|
51
|
+
│ └── global.css # Global styles
|
|
52
|
+
├── public/ # Static assets
|
|
53
|
+
├── package.json
|
|
54
|
+
├── tsconfig.json
|
|
55
|
+
└── vite.config.ts
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## Getting Started
|
|
59
|
+
|
|
60
|
+
After creating your project:
|
|
61
|
+
|
|
62
|
+
```bash
|
|
63
|
+
cd my-app
|
|
64
|
+
npm install
|
|
65
|
+
npm run dev
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Your app will be running at `http://localhost:5173`.
|
|
69
|
+
|
|
70
|
+
## Available Commands
|
|
71
|
+
|
|
72
|
+
- `npm run dev` - Start development server with hot reloading
|
|
73
|
+
- `npm run build` - Build for production
|
|
74
|
+
- `npm run start` - Start production server
|
|
75
|
+
- `npm run typecheck` - Run TypeScript type checking
|
|
76
|
+
|
|
77
|
+
## Templates
|
|
78
|
+
|
|
79
|
+
`create-rari-app` includes a default template with:
|
|
80
|
+
|
|
81
|
+
- React 19 with Server Components
|
|
82
|
+
- TypeScript configuration
|
|
83
|
+
- Vite integration
|
|
84
|
+
- Example pages and components
|
|
85
|
+
- CSS support
|
|
86
|
+
|
|
87
|
+
## Documentation
|
|
88
|
+
|
|
89
|
+
Visit [rari.build/docs](https://rari.build/docs) for:
|
|
90
|
+
|
|
91
|
+
- Complete documentation
|
|
92
|
+
- Guides and tutorials
|
|
93
|
+
- API reference
|
|
94
|
+
- Deployment guides
|
|
95
|
+
- Performance tips
|
|
96
|
+
|
|
97
|
+
## Community
|
|
98
|
+
|
|
99
|
+
- **Discord** - [Join our community](https://discord.gg/GSh2Ak3b8Q)
|
|
100
|
+
- **GitHub** - [rari-build/rari](https://github.com/rari-build/rari)
|
|
101
|
+
- **Documentation** - [rari.build/docs](https://rari.build/docs)
|
|
102
|
+
|
|
103
|
+
## Troubleshooting
|
|
104
|
+
|
|
105
|
+
### Installation Issues
|
|
106
|
+
|
|
107
|
+
If you encounter issues during installation:
|
|
108
|
+
|
|
109
|
+
1. Ensure you're using Node.js 22 or higher: `node --version`
|
|
110
|
+
2. Clear npm cache: `npm cache clean --force`
|
|
111
|
+
3. Try with a different package manager (pnpm, yarn, or bun)
|
|
112
|
+
|
|
113
|
+
### Platform-Specific Binaries
|
|
114
|
+
|
|
115
|
+
rari automatically downloads the correct binary for your platform. Supported platforms:
|
|
116
|
+
|
|
117
|
+
- macOS (Intel and Apple Silicon)
|
|
118
|
+
- Linux (x64 and ARM64)
|
|
119
|
+
- Windows (x64)
|
|
120
|
+
|
|
121
|
+
If the binary download fails, check your internet connection and firewall settings.
|
|
122
|
+
|
|
123
|
+
## Contributing
|
|
124
|
+
|
|
125
|
+
We welcome contributions! See our [Contributing Guide](https://github.com/rari-build/rari/blob/main/.github/CONTRIBUTING.md) for details.
|
|
126
|
+
|
|
127
|
+
## License
|
|
128
|
+
|
|
129
|
+
MIT License - see [LICENSE](https://github.com/rari-build/rari/blob/main/LICENSE) for details.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "create-rari-app",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.4.
|
|
4
|
+
"version": "0.4.5",
|
|
5
5
|
"description": "Create Runtime Accelerated Rendering Infrastructure (rari) applications with no build configuration",
|
|
6
6
|
"author": "Ryan Skinner",
|
|
7
7
|
"license": "MIT",
|
|
@@ -34,6 +34,8 @@
|
|
|
34
34
|
"create-rari-app": "dist/index.mjs"
|
|
35
35
|
},
|
|
36
36
|
"files": [
|
|
37
|
+
"LICENSE",
|
|
38
|
+
"README.md",
|
|
37
39
|
"dist",
|
|
38
40
|
"templates"
|
|
39
41
|
],
|