A lexicon-driven AppView for ATProto.
happyview.dev
backfill
firehose
jetstream
atproto
appview
oauth
lexicon
docs: add "Deploy with Railway" button
+13
-5
+13
-5
docs/quickstart.md
+13
-5
docs/quickstart.md
···
1
1
# Quickstart
2
2
3
-
## Prerequisites
3
+
## Deploy on Railway
4
+
5
+
The fastest way to get HappyView running is with Railway. This template deploys HappyView, AIP, Tap, and Postgres with a single click:
6
+
7
+
[](https://railway.com/deploy/I1jvZl?referralCode=0QOgj_)
8
+
9
+
## Local development
10
+
11
+
### Prerequisites
4
12
5
13
- Rust (stable)
6
14
- PostgreSQL 17+
7
15
- A running [AIP](https://github.com/graze-social/aip) instance
8
16
9
-
## 1. Clone and configure
17
+
### 1. Clone and configure
10
18
11
19
```sh
12
20
git clone https://github.com/graze-social/happyview.git
···
23
31
24
32
See [Configuration](configuration.md) for all available variables.
25
33
26
-
## 2. Start Postgres and run migrations
34
+
### 2. Start Postgres and run migrations
27
35
28
36
```sh
29
37
docker compose up -d postgres
···
32
40
33
41
Migrations run automatically on startup.
34
42
35
-
## 3. Upload a lexicon
43
+
### 3. Upload a lexicon
36
44
37
45
The first authenticated request to an admin endpoint auto-creates you as the initial admin. Authenticate with an AIP-issued Bearer token:
38
46
···
63
71
64
72
HappyView now subscribes to `games.gamesgamesgamesgames.game` on Jetstream and starts indexing records.
65
73
66
-
## 4. Query records
74
+
### 4. Query records
67
75
68
76
```sh
69
77
curl http://localhost:3000/xrpc/games.gamesgamesgamesgames.listGames?limit=10