slices.network
Auto-indexing service and GraphQL API for AT Protocol Records
quickslice.slices.network/
atproto
gleam
graphql
docs: improve README
Align main README with docs intro: focus on what Quickslice does
(spin up an AppView quickly) rather than listing technical features.
Add license section.
chadtmiller.com
+14
-9
README.md
+14
-9
README.md
···
4
4
5
5
# quickslice
6
6
7
-
GraphQL API for AT Protocol records with automatic schema generation from Lexicon definitions.
7
+
Quickslice is a quick way to spin up an [AppView](https://atproto.com/guides/glossary#app-view) for AT Protocol applications. Import your Lexicon schemas and you get a GraphQL API with OAuth authentication, real-time sync from the network, and joins across record types without setting up a database or writing any backend code.
8
8
9
-
Work in progress. APIs subject to change.
9
+
> **Warning**
10
+
> This project is in early development. APIs may change without notice.
10
11
11
-
## Features
12
+
## What Quickslice Does
12
13
13
-
- Automatic GraphQL schema generation from AT Protocol Lexicons
14
-
- Relay-compliant cursor-based pagination
15
-
- Real-time ingestion via Jetstream
16
-
- Backfill support for historical data
17
-
- SQLite storage
14
+
- **Connects to Jetstream** and tracks the record types defined in your Lexicons
15
+
- **Indexes** relevant records into a database (SQLite or Postgres)
16
+
- **Generates GraphQL** queries, mutations, and subscriptions from your Lexicon definitions
17
+
- **Handles OAuth** and writes records back to the user's PDS
18
+
- **Enables joins** by DID, URI, or strong reference, so you can query a status and its author's profile in one request
18
19
19
20
## Example
20
21
···
78
79
79
80
## Quick Start
80
81
81
-
### Docker (Fastest)
82
+
### Docker
82
83
83
84
Run Quickslice locally with Docker:
84
85
···
138
139
- `client/` - Web-based GraphQL playground and admin UI
139
140
- `quickslice-client-js/` - JavaScript client library
140
141
- `www/` - Documentation website
142
+
143
+
## License
144
+
145
+
Apache License 2.0