docs: update README to reflect Deno setup and project details

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Julien Calixte
2026-02-09 21:26:18 +01:00
parent 575852c124
commit f72f622860

View File

@@ -1,15 +1,51 @@
# litenote-jetstream # litenote-jetstream
To install dependencies: Backend for [Litenote](https://litenote.space), a blogging platform on the AT Protocol. Listens to the Jetstream firehose for `space.litenote.note` records and serves them via a REST API.
## Prerequisites
- [Deno](https://deno.land/)
## Setup
```bash ```bash
bun install # Initialize the SQLite database
deno task migrate
``` ```
To run: ## Development
```bash ```bash
bun run index.ts # Run the Jetstream listener (with watch)
deno task jetstream
# Run the API server (with watch)
deno task server
``` ```
This project was created using `bun init` in bun v1.3.8. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime. ## Production
```bash
# Run both processes
deno task jetstream:prod & deno task server:prod
```
### Docker
```bash
docker build -t litenote-jetstream .
docker run -p 8080:8080 -v litenote-data:/data litenote-jetstream
```
## API
| Endpoint | Description |
|---|---|
| `GET /notes?cursor=&limit=` | Paginated notes from all users |
| `GET /:did/notes?cursor=&limit=` | Paginated notes for a specific DID |
## Environment Variables
| Variable | Default | Description |
|---|---|---|
| `SQLITE_PATH` | `notes.db` | Path to the SQLite database file |