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. It causes a strange ORM error
18that results in invalid queries being sent to the database.
19
20$ git clone https://tangled.org/emmeline.girlkisser.top/beep
21$ cd beep
22$ cp config.maple config.real.maple
23
24Edit config.real.maple to set ports, auth, etc.
25
26`config.real.maple` also has settings to configure the
27default theme, post length, username length, welcome
28messages, etc etc.
29
30[WARNING] DO NOT PUT SECRETS IN config.maple
31config.maple is intended to be pushed to Git as a template
32config for your instance. Instead, put your secrets in
33config.real.maple, which is gitignored.
34TODO: Read secrets from .env automatically.
35
36With Docker:
37 $ docker compose up
38
39Without Docker:
40 (assumes you already have a database somewhere)
41 $ v install EmmaTheMartian.Maple
42 $ v .
43 $ ./beep config.real.maple
44
45 If `v install ...` fails then you can install Maple
46 manually:
47 $ mkdir -p ~/.vmodules/emmathemartian/maple
48 $ git clone https://github.com/emmathemartian/maple ~/.vmodules/emmathemartian/maple