repos / pico

commit

207b6d9

parent

46bb406

author

Eric Bower

date

2022-08-01 14:08:47 +0000 UTC

fix: add readme

Also update references to our repos to point to the new pico repo

 1@@ -0,0 +1,72 @@
 2+# pico services
 3+
 4+This repo hosts the following pico services:
 5+
 6+- [prose.sh](https://prose.sh)
 7+- [lists.sh](https://lists.sh)
 8+- [pastes.sh](https://pastes.sh)
 9+
10+## comms
11+
12+- [website](https://pico.sh)
13+- [irc #pico.sh](irc://irc.libera.chat/#pico.sh)
14+- [mailing list](https://lists.sr.ht/~erock/pico.sh)
15+- [ticket tracker](https://todo.sr.ht/~erock/pico.sh)
16+- [email](mailto:hello@pico.sh)
17+
18+## development
19+
20+- `golang` >= 1.18
21+- `direnv` to load environment vars 
22+
23+```bash
24+cp ./.env.example .env
25+```
26+
27+Boot up database
28+
29+```bash
30+docker compose up -d
31+```
32+
33+Create db and migrate
34+
35+```bash
36+make create
37+make migrate
38+```
39+
40+Build services
41+
42+```bash
43+make build
44+```
45+
46+All services are built inside the `./build` folder.
47+
48+If you want to start prose:
49+
50+```bash
51+./build/prose-web
52+# in a separate terminal
53+./build/prose-ssh
54+```
55+
56+## deployment
57+
58+We use an image based deployment, so all of our images are uploaded to
59+[hub.docker.com](https://hub.docker.com/u/neurosnap)
60+
61+```bash
62+DOCKER_TAG=latest make bp-all
63+```
64+
65+Then ssh into the production server and run:
66+
67+```bash
68+./start.sh pull
69+./start.sh
70+```
71+
72+For any migrations, right dropping into `psql` on our production database and
73+pasting the SQL.  This process is a WIP and will update over time.

1@@ -9,5 +9,5 @@ Built and maintained by pico.sh
2 => /ops ops
3 => /help help
4 => /rss rss
5-=> https://github.com/neurosnap/lists.sh source
6+=> https://git.sr.ht/~erock/pico source
7 {{end}}

1@@ -8,7 +8,7 @@
2         <a href="/ops">ops</a> |
3         <a href="/help">help</a> |
4         <a href="/rss">rss</a> |
5-        <a href="https://git.sr.ht/~erock/pico/lists">source</a>
6+        <a href="https://git.sr.ht/~erock/pico">source</a>
7     </div>
8 </footer>
9 {{end}}

1@@ -6,7 +6,7 @@
2         <a href="/">home</a> |
3         <a href="/ops">ops</a> |
4         <a href="/help">help</a> |
5-        <a href="https://git.sr.ht/~erock/pastes.sh">source</a>
6+        <a href="https://git.sr.ht/~erock/pico">source</a>
7     </div>
8 </footer>
9 {{end}}

1@@ -7,7 +7,7 @@
2         <a href="/ops">ops</a> |
3         <a href="/help">help</a> |
4         <a href="/rss">rss</a> |
5-        <a href="https://git.sr.ht/~erock/pico/prose">source</a>
6+        <a href="https://git.sr.ht/~erock/pico">source</a>
7     </div>
8 </footer>
9 {{end}}