a mini social media app for small communities
1# beep
2
3> *a legendary land of lowercase lovers.*
4
5a self-hosted mini-blogger.
6
7technically made because i wanted to mess around with rss, but i also wanted a
8teensy little blog/slow-paced-chat-app for myself and my friends.
9
10## hosting
11
12you will need a postgresql database somewhere, along with v to compile beep:
13
14edit `config.maple` to set the url, port, username, password, and database name.
15
16> `config.maple` also has settings to configure the feel of your beep instance,
17> including toggling images, post length, username length, etc etc.
18
19> **do not** push your `config.maple`'s secrets to git!
20> instead, use `config.real.maple` if you plan to push anywhere.
21> it will be gitignored to keep your secrets a secret.
22
23```sh
24git clone https://github.com/emmathemartian/beep
25cd beep
26v -prod .
27./beep config.maple
28```
29
30then go to the configured url to view (default is `http://localhost:8008`).
31
32if you do not have a database, you can either self-host a postgresql database on
33your machine, or you can find a free one online. i use and like
34[neon.tech](https://neon.tech), their free plan is pretty comfortable for a
35small beep instance!