Files
remanso-jetstream/README.md
2026-02-14 12:08:22 +01:00

52 lines
1.0 KiB
Markdown

# litenote-jetstream
Backend for [Remanso](https://remanso.space), a blogging platform on the AT Protocol. Listens to the Jetstream firehose for `space.remanso.note` records and serves them via a REST API.
## Prerequisites
- [Deno](https://deno.land/)
## Setup
```bash
# Initialize the SQLite database
deno task migrate
```
## Development
```bash
# Run the Jetstream listener (with watch)
deno task jetstream
# Run the API server (with watch)
deno task server
```
## 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 |