@codaijs/keel 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 +117 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/Chafficui/keel/main/brand/icon.png" alt="Keel" width="100" />
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
<h1 align="center">Keel</h1>
|
|
6
|
+
|
|
7
|
+
<p align="center">
|
|
8
|
+
<strong>The full-stack framework built for AI.</strong><br/>
|
|
9
|
+
Auth, database, email, mobile — ready in one command.
|
|
10
|
+
</p>
|
|
11
|
+
|
|
12
|
+
<p align="center">
|
|
13
|
+
<a href="https://keel.codai.app">Website</a> · <a href="https://keel.codai.app">Docs</a> · <a href="https://github.com/Chafficui/keel">GitHub</a>
|
|
14
|
+
</p>
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
npx @codaijs/keel create my-app
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
Follow the interactive wizard to configure your project — database, auth, email, and optional sails.
|
|
25
|
+
|
|
26
|
+
### Zero-Config (no Docker needed)
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
npx @codaijs/keel create my-app --yes --db=pglite
|
|
30
|
+
cd my-app
|
|
31
|
+
keel dev
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### With Options
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npx @codaijs/keel create my-app --yes # All defaults
|
|
38
|
+
npx @codaijs/keel create my-app --yes --db=docker # Docker PostgreSQL
|
|
39
|
+
npx @codaijs/keel create my-app --yes --db=url --db-url=... # Custom DB URL
|
|
40
|
+
npx @codaijs/keel create my-app --yes --sails=stripe,google-oauth
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
## What You Get
|
|
44
|
+
|
|
45
|
+
| Layer | Stack |
|
|
46
|
+
|-------|-------|
|
|
47
|
+
| **Frontend** | Vite + React 19 + TypeScript + TailwindCSS v4 |
|
|
48
|
+
| **Backend** | Express 5 + TypeScript (ESM) |
|
|
49
|
+
| **Auth** | BetterAuth — email/password, sessions, verification |
|
|
50
|
+
| **Email** | Resend + React Email templates |
|
|
51
|
+
| **Database** | PostgreSQL + Drizzle ORM (migrations) |
|
|
52
|
+
| **Mobile** | Capacitor 8 — iOS + Android |
|
|
53
|
+
| **AI** | CLAUDE.md, .cursor/rules, copilot-instructions — built in |
|
|
54
|
+
|
|
55
|
+
## CLI Commands
|
|
56
|
+
|
|
57
|
+
### Development
|
|
58
|
+
|
|
59
|
+
```bash
|
|
60
|
+
keel dev # Start dev servers + database
|
|
61
|
+
keel start # Production build + start
|
|
62
|
+
keel doctor # Health check your project
|
|
63
|
+
keel env # Show env var status
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Code Generators
|
|
67
|
+
|
|
68
|
+
```bash
|
|
69
|
+
keel generate route <name> # Scaffold Express route
|
|
70
|
+
keel generate page <name> # Scaffold React page
|
|
71
|
+
keel generate email <name> # Scaffold email template
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### Sails (Extensions)
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
keel sail add <name> # Install a sail
|
|
78
|
+
keel sail remove <name> # Remove a sail
|
|
79
|
+
keel list # List all available sails
|
|
80
|
+
keel info <name> # Show sail details
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
### Database
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
keel db:reset # Drop + re-migrate
|
|
87
|
+
keel db:studio # Open Drizzle Studio
|
|
88
|
+
keel db:seed # Run seed file
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
## Available Sails
|
|
92
|
+
|
|
93
|
+
| Sail | What it adds |
|
|
94
|
+
|------|-------------|
|
|
95
|
+
| **google-oauth** | Google sign-in + OAuth config |
|
|
96
|
+
| **stripe** | Subscriptions, checkout, webhooks, portal |
|
|
97
|
+
| **gdpr** | Consent, data export, account deletion, privacy policy |
|
|
98
|
+
| **r2-storage** | Cloudflare R2 file uploads |
|
|
99
|
+
| **push-notifications** | Firebase Cloud Messaging |
|
|
100
|
+
| **analytics** | PostHog tracking |
|
|
101
|
+
| **admin-dashboard** | User management + metrics |
|
|
102
|
+
| **i18n** | i18next localization |
|
|
103
|
+
|
|
104
|
+
## Requirements
|
|
105
|
+
|
|
106
|
+
- Node.js >= 22
|
|
107
|
+
- npm >= 10
|
|
108
|
+
|
|
109
|
+
## Links
|
|
110
|
+
|
|
111
|
+
- [Documentation](https://keel.codai.app)
|
|
112
|
+
- [GitHub](https://github.com/Chafficui/keel)
|
|
113
|
+
- [Report Issues](https://github.com/Chafficui/keel/issues)
|
|
114
|
+
|
|
115
|
+
## License
|
|
116
|
+
|
|
117
|
+
MIT
|