a mini social media app for small communities
1
2beep
3====
4
5> *a legendary land of lowercase lovers.*
6
7A self-hosted "social-media-oriented" mini-blogger.
8
9Technically made because I wanted to mess around with RSS,
10but I also wanted a teensy little blog/slow-paced-chat-app
11for myself and my friends.
12
13hosting
14-------
15
16[WARNING]
17Do not compile with -prod. V's AST optimizations break
18something in the ORM and cause assorted errors. Instead,
19use `-cflags "-O3 -flto"`
20
21$ git clone https://tangled.org/emmeline.girlkisser.top/beep
22$ cd beep
23$ cp config.maple config.real.maple
24
25Edit config.real.maple to set ports, auth, etc.
26
27`config.real.maple` also has settings to configure the
28default theme, post length, username length, welcome
29messages, etc etc.
30
31[WARNING] DO NOT PUT SECRETS IN config.maple
32config.maple is intended to be pushed to Git as a template
33config for your instance. Instead, put your secrets in
34config.real.maple, which is gitignored.
35TODO: Read secrets from .env automatically.
36
37With Docker:
38 $ docker compose up
39
40Without Docker:
41 (assumes you already have a database somewhere)
42 $ v install EmmaTheMartian.Maple
43 $ v -cflags "-O3 -flto" .
44 $ ./beep
45
46 If `v install ...` fails then you can install Maple
47 manually:
48 $ mkdir -p ~/.vmodules/emmathemartian/maple
49 $ git clone https://github.com/emmathemartian/maple ~/.vmodules/emmathemartian/maple