slices.network
A starter kit for building apps with quickslice #getsliced
chadtmiller.com
1# Slice Kit
2
3A starter kit for building apps on the Atmosphere with [Quickslice](https://tangled.org/slices.network/quickslice).
4
5## Prerequisites
6
7- [Docker](https://docs.docker.com/get-docker/)
8- [Node.js](https://nodejs.org/)
9
10## Quick Start
11
121. Start the server:
13
14```bash
15docker compose up
16```
17
182. Login at http://127.0.0.1:8080 to create an admin account
19
203. Go to the settings page. Enter your domain authority (e.g., `com.example`) - this is the namespace for your app's lexicons. Leave blank if unsure; `app.bsky.actor.profile` will be treated as an external collection.
21
224. Upload `lexicons.zip` in the Lexicons section
23
245. Register an OAuth client at http://127.0.0.1:8080/oauth/clients
25
26 - Name: `frontend client`
27 - Type: `public`
28 - Redirect URIs: `http://localhost:3000/`
29 - Scope: `atproto transition:generic`
30
316. Copy the client ID and set it in `index.html`:
32
33```javascript
34const CLIENT_ID = "your_client_id_here";
35```
36
377. Serve the frontend:
38
39```bash
40make serve
41```
42
438. Open http://localhost:3000 and login with your Bluesky handle. You should see your Bluesky avatar and profile info after logging in, it's synced automatically after logging in.
44
459. Configure the Quickslice MCP server for your AI assistant. Example:
46
47```bash
48claude mcp add --scope user quickslice http://127.0.0.1:8080/mcp
49```
50
5110. Add your own custom lexicons to the `/lexicons` folder, run `make zip`, and upload on the settings page. Ask the Quickslice MCP about your lexicons and use it to help build your app.
52
53## Configuration
54
55Environment variables in `docker-compose.yml`:
56
57| Variable | Description |
58|----------|-------------|
59| `DATABASE_URL` | SQLite database path |
60| `SECRET_KEY_BASE` | Session signing key (generate your own for production) |
61| `OAUTH_SIGNING_KEY` | OAuth token signing key (generate your own for production) |
62| `OAUTH_LOOPBACK_MODE` | Enables localhost OAuth redirects for development |
63| `EXTERNAL_BASE_URL` | Public URL of your server |
64
65## Make Commands
66
67| Command | Description |
68|---------|-------------|
69| `make serve` | Serve frontend locally |
70| `make format` | Format HTML files with Prettier |
71| `make zip` | Create `lexicons.zip` from lexicons directory |
72
73## Production
74
75**Backend:** See the [deployment guide](https://quickslice.slices.network/guides/deployment) for deploying your Quickslice instance.
76
77**Frontend:** Deploy to a CDN or [wisp.place](https://wisp.place).