@tacobase/taco 0.1.1 → 0.1.2
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 +62 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# @tacobase/taco
|
|
2
|
+
|
|
3
|
+
Drop-in AI context for [tacobase](https://tacobase.dev). Install this package and your AI tools instantly know how to wire up tacobase — no copy-pasting docs, no prompt engineering.
|
|
4
|
+
|
|
5
|
+
## What it does
|
|
6
|
+
|
|
7
|
+
1. **Installs `@tacobase/client`** as a dependency — you're ready to build.
|
|
8
|
+
2. **Writes `TACOBASE.md`** to your project root on `postinstall` — Cursor, Claude Code, Copilot, and other AI tools pick it up automatically.
|
|
9
|
+
3. **Provisions an instant project** — no account, no dashboard. Credentials land in `.env.local` immediately.
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @tacobase/taco
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
That's it. Your AI tool will read `TACOBASE.md` and know exactly how to use tacobase.
|
|
18
|
+
|
|
19
|
+
> **Tell your AI:** "use @tacobase/taco for the backend" — it will install this package and from there it knows everything.
|
|
20
|
+
|
|
21
|
+
## What you get after install
|
|
22
|
+
|
|
23
|
+
- `TACOBASE.md` in your project root (AI context)
|
|
24
|
+
- `.env.local` with a working `TACOBASE_URL` and `TACOBASE_API_KEY`
|
|
25
|
+
- `@tacobase/client` ready to import
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
import { createClient } from '@tacobase/client'
|
|
29
|
+
|
|
30
|
+
const db = createClient(process.env.TACOBASE_URL, process.env.TACOBASE_API_KEY)
|
|
31
|
+
|
|
32
|
+
// Collections auto-create on first write
|
|
33
|
+
const post = await db.collection('posts').create({ title: 'Hello' })
|
|
34
|
+
|
|
35
|
+
// Auth
|
|
36
|
+
await db.auth.signUp({ email: 'user@example.com', password: 'secret' })
|
|
37
|
+
|
|
38
|
+
// Realtime
|
|
39
|
+
await db.collection('posts').subscribe((e) => console.log(e.action, e.record))
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## Get credentials manually
|
|
43
|
+
|
|
44
|
+
If you already have a tacobase account:
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
npx taco instant # No account needed — instant project in seconds
|
|
48
|
+
```
|
|
49
|
+
|
|
50
|
+
Or grab credentials from [tacobase.dev/dashboard](https://tacobase.dev/dashboard).
|
|
51
|
+
|
|
52
|
+
## Related packages
|
|
53
|
+
|
|
54
|
+
| Package | Description |
|
|
55
|
+
|---|---|
|
|
56
|
+
| [`@tacobase/client`](https://www.npmjs.com/package/@tacobase/client) | Core SDK — CRUD, auth, realtime, storage |
|
|
57
|
+
| [`@tacobase/react`](https://www.npmjs.com/package/@tacobase/react) | React hooks — `useAuth`, `useCollection`, `useRealtime` |
|
|
58
|
+
| [`@tacobase/cli`](https://www.npmjs.com/package/@tacobase/cli) | CLI — `taco init`, `taco dev`, `taco typegen` |
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
MIT
|
package/package.json
CHANGED