@genui-a3/create 0.1.0 → 0.1.1
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 +87 -0
- package/package.json +1 -1
- package/template/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
# @genui-a3/create
|
|
2
|
+
|
|
3
|
+
Scaffold a new [A3](https://www.npmjs.com/package/@genui-a3/core) agentic app in seconds.
|
|
4
|
+
|
|
5
|
+
## Quick Start
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npx @genui-a3/create@latest my-app
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
This will:
|
|
12
|
+
|
|
13
|
+
1. Create a new directory with your project name
|
|
14
|
+
1. Copy a production-ready Next.js template
|
|
15
|
+
1. Install all dependencies automatically
|
|
16
|
+
|
|
17
|
+
Then start developing:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
cd my-app
|
|
21
|
+
npm run dev
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Open [http://localhost:3000](http://localhost:3000) to see your app.
|
|
25
|
+
|
|
26
|
+
## What You Get
|
|
27
|
+
|
|
28
|
+
A fully configured Next.js application with:
|
|
29
|
+
|
|
30
|
+
- **Chat interface** — conversational UI backed by A3 agents
|
|
31
|
+
- **Streaming responses** — real-time streamed agent output
|
|
32
|
+
- **AG-UI protocol support** — compatible with the [AG-UI](https://docs.ag-ui.com) standard
|
|
33
|
+
- **Agent registration** — define and wire up custom agents using `@genui-a3/core`
|
|
34
|
+
- **Material UI** — pre-configured theming with MUI components
|
|
35
|
+
- **TypeScript** — strict type-checking out of the box
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# Interactive — prompts for a project name
|
|
41
|
+
npx @genui-a3/create@latest
|
|
42
|
+
|
|
43
|
+
# Non-interactive — pass the name directly
|
|
44
|
+
npx @genui-a3/create@latest my-app
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
The CLI will not overwrite a non-empty directory.
|
|
48
|
+
|
|
49
|
+
## Project Structure
|
|
50
|
+
|
|
51
|
+
```
|
|
52
|
+
my-app/
|
|
53
|
+
├── app/
|
|
54
|
+
│ ├── (pages)/ # Route groups (chat, stream, agui)
|
|
55
|
+
│ ├── agents/ # Agent definitions
|
|
56
|
+
│ ├── api/ # API routes
|
|
57
|
+
│ ├── components/ # Shared UI components
|
|
58
|
+
│ ├── layout.tsx # Root layout
|
|
59
|
+
│ └── page.tsx # Landing page
|
|
60
|
+
├── public/ # Static assets
|
|
61
|
+
├── package.json
|
|
62
|
+
├── tsconfig.json
|
|
63
|
+
└── next.config.mjs
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Available Scripts
|
|
67
|
+
|
|
68
|
+
Inside a generated project you can run:
|
|
69
|
+
|
|
70
|
+
| Command | Description |
|
|
71
|
+
|---------|-------------|
|
|
72
|
+
| `npm run dev` | Start the development server |
|
|
73
|
+
| `npm run build` | Create a production build |
|
|
74
|
+
| `npm start` | Run the production server |
|
|
75
|
+
|
|
76
|
+
## Prerequisites
|
|
77
|
+
|
|
78
|
+
- Node.js 20.19.0 or later
|
|
79
|
+
- npm 10+
|
|
80
|
+
|
|
81
|
+
## Related
|
|
82
|
+
|
|
83
|
+
- [@genui-a3/core](https://www.npmjs.com/package/@genui-a3/core) — the core A3 agentic framework that powers scaffolded apps
|
|
84
|
+
|
|
85
|
+
## License
|
|
86
|
+
|
|
87
|
+
ISC
|
package/package.json
CHANGED
package/template/package.json
CHANGED