vielle.dev
[WIP] A (somewhat barebones) atproto app for creating custom sites without hosting!
meta: add running instructions for server, add run script to deno.json, and add alpha warning
+6
-3
README.md
+6
-3
README.md
···
2
2
3
3
A (somewhat barebones) atproto app for creating custom sites without hosting!
4
4
5
+
> [!CAUTION]
6
+
> This software is super duper alpha and not tested thoroughly! Use at your own risk!
7
+
5
8
- Lexicons are located at [`./lexicons`](./lexicons/)
6
9
- Server backend is located at [`./server`](./server/)
7
10
- Upload CLI is located at [`./upload`](./upload/)
···
11
14
## How to:
12
15
13
16
**View someones site?**
14
-
Head to `https://<handle>.atcities.dev/` or `https://<did>.did-<method>.atcities.dev/`.
17
+
> Head to `https://<handle>.atcities.dev/` or `https://<did>.did-<method>.atcities.dev/`.
15
18
16
19
**Upload your own site?**
17
-
Use the upload cli. Installation guide below.
20
+
> Use the upload cli. Installation guide below.
18
21
19
22
**Self host atcities.dev?**
20
-
Clone this repo and setup the `.env` file for `/server`, then \<build & run instructions here once complete\>
23
+
> Clone this repo and setup the `.env` file for `/server`, then run `deno run run`
21
24
22
25
### CLI installation guide.
23
26
+1
server/deno.json
+1
server/deno.json
···
1
1
{
2
2
"tasks": {
3
3
"dev": "deno run --watch --allow-net --allow-env --allow-sys --allow-read=/usr/bin/ldd,./blobs,./src --allow-write=./blobs --allow-ffi --env-file src/index.ts",
4
+
"run": "deno run --allow-net --allow-env --allow-sys --allow-read=/usr/bin/ldd,./blobs,./src --allow-write=./blobs --allow-ffi --env-file src/index.ts",
4
5
"lexgen": "deno run --allow-env --allow-sys --allow-read=.. --allow-write=./src/lexicons --no-prompt @atcute/lex-cli generate -c ./lex.config.js && cat ./src/lexicons/index.ts | sed \"s/.js/.ts/\" > ./src/lexicons/index.ts",
5
6
"dk": "deno run -A --node-modules-dir npm:drizzle-kit"
6
7
},