create-ereo 0.1.6

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.
Files changed (3) hide show
  1. package/README.md +129 -0
  2. package/dist/index.js +1471 -0
  3. package/package.json +32 -0
package/README.md ADDED
@@ -0,0 +1,129 @@
1
+ # create-ereo
2
+
3
+ Scaffold a new EreoJS project with a single command. Creates a fully configured React fullstack application powered by Bun.
4
+
5
+ ## Usage
6
+
7
+ ```bash
8
+ bunx create-ereo my-app
9
+ ```
10
+
11
+ Or with npm/npx:
12
+
13
+ ```bash
14
+ npx create-ereo my-app
15
+ ```
16
+
17
+ ## Quick Start
18
+
19
+ ```bash
20
+ # Create a new project with the default template
21
+ bunx create-ereo my-app
22
+
23
+ # Navigate to the project
24
+ cd my-app
25
+
26
+ # Start the development server
27
+ bun run dev
28
+
29
+ # Open http://localhost:3000
30
+ ```
31
+
32
+ ## Templates
33
+
34
+ Choose from multiple starter templates:
35
+
36
+ ```bash
37
+ # Minimal template - bare essentials
38
+ bunx create-ereo my-app --template minimal
39
+
40
+ # Default template - standard setup
41
+ bunx create-ereo my-app --template default
42
+
43
+ # Tailwind template - full-featured with Tailwind CSS (default)
44
+ bunx create-ereo my-app --template tailwind
45
+ ```
46
+
47
+ ### Template Contents
48
+
49
+ **Minimal:**
50
+ - Basic project structure
51
+ - Single route
52
+ - TypeScript configuration
53
+
54
+ **Tailwind (default):**
55
+ - Complete project structure
56
+ - Multiple example routes (Home, Blog, Contact, About)
57
+ - Navigation and Footer components
58
+ - Interactive Counter island component
59
+ - Blog with dynamic routes
60
+ - Contact form with actions
61
+ - Error boundary and 404 page
62
+ - Tailwind CSS with custom theme
63
+ - TypeScript with path aliases
64
+
65
+ ## Options
66
+
67
+ | Option | Alias | Description |
68
+ |--------|-------|-------------|
69
+ | `--template` | `-t` | Template to use (minimal, default, tailwind) |
70
+ | `--no-typescript` | | Use JavaScript instead of TypeScript |
71
+ | `--no-git` | | Skip git initialization |
72
+ | `--no-install` | | Skip package installation |
73
+ | `--help` | `-h` | Show help message |
74
+
75
+ ## Examples
76
+
77
+ ```bash
78
+ # Create with minimal template
79
+ bunx create-ereo my-app -t minimal
80
+
81
+ # Create without TypeScript
82
+ bunx create-ereo my-app --no-typescript
83
+
84
+ # Create without installing dependencies
85
+ bunx create-ereo my-app --no-install
86
+
87
+ # Create without git initialization
88
+ bunx create-ereo my-app --no-git
89
+ ```
90
+
91
+ ## Project Structure
92
+
93
+ After creation, your project will have:
94
+
95
+ ```
96
+ my-app/
97
+ app/
98
+ components/ # Reusable React components
99
+ lib/ # Utilities and data
100
+ routes/ # File-based routes
101
+ styles.css # Global styles
102
+ public/ # Static assets
103
+ ereo.config.ts # EreoJS configuration
104
+ package.json
105
+ tsconfig.json
106
+ tailwind.config.js
107
+ ```
108
+
109
+ ## Key Features
110
+
111
+ - Interactive project scaffolding
112
+ - Multiple template options
113
+ - TypeScript or JavaScript support
114
+ - Automatic git initialization
115
+ - Automatic dependency installation
116
+ - Tailwind CSS integration
117
+ - Example routes demonstrating EreoJS features
118
+
119
+ ## Documentation
120
+
121
+ For full documentation, visit [https://ereo.dev/docs/getting-started](https://ereo.dev/docs/getting-started)
122
+
123
+ ## Part of EreoJS
124
+
125
+ This package is part of the [EreoJS monorepo](https://github.com/anthropics/ereo-js).
126
+
127
+ ## License
128
+
129
+ MIT