+29
-5
README.md
+29
-5
README.md
···
8
8
- Web GUI **will be** located at [`./web-gui`](./web-gui/)
9
9
- Fuse tool **will be** located at [`./fuse`](./fuse/)
10
10
11
-
TODO:
11
+
## How to:
12
+
13
+
**View someones site?**
14
+
Head to `https://<handle>.atcities.dev/` or `https://<did>.did-<method>.atcities.dev/`.
15
+
16
+
**Upload your own site?**
17
+
Use the upload cli. Installation guide below.
18
+
19
+
**Self host atcities.dev?**
20
+
Clone this repo and setup the `.env` file for `/server`, then \<build & run instructions here once complete\>
21
+
22
+
### CLI installation guide.
23
+
24
+
1. Build from source:
25
+
Prerequisites: `git` `cargo` `rust`
26
+
```sh
27
+
git clone https://tangled.org/@vielle.dev/atcities.dev
28
+
cd atcities.dev/upload
29
+
cargo build
30
+
sudo cp ./target/debug/atcities-upload /bin
31
+
# Reload your shell environment
32
+
atcities-upload --version
33
+
```
34
+
35
+
## Todo:
12
36
13
37
- [x] Resolve `handle.host` and `did.did-method.host` domains to records/blobs
14
38
- [x] Backfill network
···
16
40
- [x] Store blobs for CDN (max ~0.25gb per user)
17
41
- [x] Moderate illegal content or hope that people are niceys
18
42
(Hope that people are niceys)
19
-
- [ ] Finish CLI tool
20
-
- [ ] Sign in via app password
21
-
- [ ] Clear old site
22
-
- [ ] Upload new site
43
+
- [x] Finish CLI tool
44
+
- [x] Sign in via app password
45
+
- [x] Clear old site
46
+
- [x] Upload new site
23
47
- [ ] Fuse uploader
24
48
- [ ] Web GUI uploader