slices.network
Highly ambitious ATProtocol AppView service and sdks
update getting started docs
chadtmiller.com
+19
-4
docs/getting-started.md
+19
-4
docs/getting-started.md
···
10
10
11
11
```bash
12
12
# Install from JSR
13
-
deno install -g jsr:@slices/cli --name slices
13
+
deno install -g -A jsr:@slices/cli --name slices
14
+
```
15
+
16
+
### Login to Slices
17
+
18
+
Before creating a project, authenticate with your AT Protocol account:
19
+
20
+
```bash
21
+
slices login
14
22
```
23
+
24
+
This will open a browser window where you can authorize the CLI with your AT
25
+
Protocol handle.
15
26
16
27
### Create Your Project
17
28
···
364
375
365
376
### Deno Deploy
366
377
367
-
Create a free account at [deno.com/deploy](https://deno.com/deploy). Push your code to GitHub, then connect your repository through the Deno Deploy dashboard to deploy your app.
378
+
Create a free account at [deno.com/deploy](https://deno.com/deploy). Push your
379
+
code to GitHub, then connect your repository through the Deno Deploy dashboard
380
+
to deploy your app.
368
381
369
-
For production use with Deno Deploy, switch from SQLite to Deno KV for OAuth and session storage:
382
+
For production use with Deno Deploy, switch from SQLite to Deno KV for OAuth and
383
+
session storage:
370
384
371
385
```typescript
372
386
import { DenoKVOAuthStorage } from "@slices/oauth";
···
391
405
});
392
406
```
393
407
394
-
Deno KV provides serverless-compatible storage that scales automatically with your deployment.
408
+
Deno KV provides serverless-compatible storage that scales automatically with
409
+
your deployment.
395
410
396
411
## Manual Setup (Advanced)
397
412
+12
-6
docs/intro.md
+12
-6
docs/intro.md
···
37
37
38
38
```bash
39
39
# Install the CLI globally
40
-
deno install -g jsr:@slices/cli --name slices
40
+
deno install -g -A jsr:@slices/cli --name slices
41
41
42
42
# Initialize a new slice project
43
43
slices init my-app
···
47
47
deno task dev
48
48
```
49
49
50
-
The `slices init` command creates a full-stack Deno app with OAuth authentication, automatically creates your slice on the network, and generates a type-safe TypeScript SDK.
50
+
The `slices init` command creates a full-stack Deno app with OAuth
51
+
authentication, automatically creates your slice on the network, and generates a
52
+
type-safe TypeScript SDK.
51
53
52
54
## Simple Example
53
55
···
105
107
106
108
## Key Features
107
109
108
-
- **Schema Validation**: Define lexicons that enforce data structure and constraints
109
-
- **Auto-generated APIs**: REST endpoints created automatically from your schemas
110
+
- **Schema Validation**: Define lexicons that enforce data structure and
111
+
constraints
112
+
- **Auto-generated APIs**: REST endpoints created automatically from your
113
+
schemas
110
114
- **TypeScript SDKs**: Type-safe clients generated from your lexicons
111
115
- **Real-time Sync**: Automatic synchronization across the AT Protocol network
112
-
- **Advanced Querying**: Filter, sort, and paginate records with a powerful query API
116
+
- **Advanced Querying**: Filter, sort, and paginate records with a powerful
117
+
query API
113
118
- **OAuth Built-in**: Authentication with any AT Protocol account
114
119
115
120
## When to Use Slices
116
121
117
122
Slices is ideal for:
118
123
119
-
- **Social Applications**: Build specialized communities, forums, or social features
124
+
- **Social Applications**: Build specialized communities, forums, or social
125
+
features
120
126
- **Content Platforms**: Create blogs, documentation sites, or media libraries
121
127
- **SaaS Products**: Develop collaborative tools with structured data needs
122
128
- **Web APIs**: Design REST APIs with automatic validation and documentation