Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
dromzeh committed Apr 1, 2024
1 parent f8f09d2 commit 7260f4c
Showing 1 changed file with 17 additions and 1 deletion.
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,30 @@

![Quality]

Source code for the API powering [**wanderer.moe**](https://wanderer.moe) — using **Cloudflare Workers** and **Hono** with **R2 Storage** for the CDN, **Turso** and **Drizzle**. Durable Objects are used for rate limiting requests.
Source code for the API powering [**wanderer.moe**](https://wanderer.moe).

Tech Stack:

- Turso - Database (Libsql, fork of SQLite)
- Drizzle - ORM
- Hono - Framework
- Scalar - OpenAPI Documentation
- Bun - Bun
- Resend - Emails
- Cloudflare R2 - Storage
- Cloudflare DO - Ratelimiting
- Lucia Auth - Authentication

</div>

---

## Usage

### Bun

Bun is relatively lightweight and easy to use. You can install it with `npm i bun -g` globally using `npm`.

### Turso

We use Turso (libsql, very lightweight fork of SQLite) as our database. You will need to install the [Turso CLI](https://docs.turso.tech/reference/turso-cli#installation) then run `turso dev` to start a local database. You can persist data by passing `--db-file <path>`.
Expand Down

0 comments on commit 7260f4c

Please sign in to comment.