Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add add-on docs #272

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
51 changes: 51 additions & 0 deletions documentation/docs/30-add-ons/05-drizzle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
title: drizzle
---

## Usage

```bash
npx sv add drizzle
```

## Description

[Drizzle ORM](https://orm.drizzle.team/) is a headless TypeScript ORM with a head.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

headless with a head? lol. I just checked and that's their tagline, but it's completely unintelligible, so I think we should write our own description for it 😄

Some short description about what drizzle is and what we set up

## Options

### database

Which database variant to use:

- `postgresql` — tbd
- `mysql` — tbd
- `sqlite` — runs everywhere, local database

```bash
npx sv add --drizzle=postgresql
```

### client

The sql client to use, depends on `database`:

- For `postgresql`: `postgres.js`, `neon`,
- For `mysql`: `mysql2`, `planetscale`
- For `sqlite`: `better-sqlite3`, `libsql`, `turso`

```bash
npx sv add --drizzle=postgresql,postgres.js
```

manuel3108 marked this conversation as resolved.
Show resolved Hide resolved
### docker

Whether to add docker compose configuration. Only available for [`database`](#Options-database) `postgresql` or `mysql`

- `docker` - generates `docker-compose.yml`
- `no-docker` - does not generate docker config

```bash
npx sv add --drizzle=postgresql,postgres.js,docker
```
3 changes: 3 additions & 0 deletions documentation/docs/30-add-ons/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
---
title: Add-ons
---