create-avalon 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 +59 -0
- package/dist/cli.js +1407 -0
- package/package.json +29 -0
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# create-avalon
|
|
2
|
+
|
|
3
|
+
Scaffold a new [Avalon](https://useavalon.dev) project in seconds.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm create avalon@latest
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or with other package managers:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
pnpm create avalon@latest
|
|
15
|
+
yarn create avalon
|
|
16
|
+
bun create avalon
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
The CLI walks you through:
|
|
20
|
+
|
|
21
|
+
- Project name and directory
|
|
22
|
+
- Framework selection (React, Preact, Vue, Svelte, Solid, Lit, Qwik — or multiple)
|
|
23
|
+
- Styling approach (CSS Modules, Tailwind, vanilla CSS)
|
|
24
|
+
- Optional features (API routes, middleware, layouts, MDX)
|
|
25
|
+
- Package manager preference
|
|
26
|
+
|
|
27
|
+
## What you get
|
|
28
|
+
|
|
29
|
+
A ready-to-run Avalon project with file-system routing, islands architecture, and zero JavaScript by default.
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
my-project/
|
|
33
|
+
├── app/
|
|
34
|
+
│ ├── modules/
|
|
35
|
+
│ │ └── home/
|
|
36
|
+
│ │ ├── pages/ # File-system routes
|
|
37
|
+
│ │ ├── components/ # Interactive components
|
|
38
|
+
│ │ └── layouts/ # Module layouts
|
|
39
|
+
│ └── shared/
|
|
40
|
+
│ ├── layouts/ # Root layout
|
|
41
|
+
│ ├── components/ # Shared components
|
|
42
|
+
│ └── styles/ # Global styles & tokens
|
|
43
|
+
├── middleware/ # Server middleware
|
|
44
|
+
├── routes/
|
|
45
|
+
│ └── api/ # API routes
|
|
46
|
+
├── server/ # Server config & env
|
|
47
|
+
├── public/ # Static assets
|
|
48
|
+
├── vite.config.ts
|
|
49
|
+
└── package.json
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## Links
|
|
53
|
+
|
|
54
|
+
- [Documentation](https://useavalon.dev/docs/introduction)
|
|
55
|
+
- [GitHub](https://github.com/useAvalon/Avalon)
|
|
56
|
+
|
|
57
|
+
## License
|
|
58
|
+
|
|
59
|
+
MIT
|