a mini social media app for small communities
emmeline.girlkisser.top
1# beep
2
3> *a legendary land of lowercase lovers.*
4
5a self-hosted "social-media-oriented" 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
14copy the `config.maple` as `config.real.maple`
15
16edit `config.real.maple` to set the url, port, username, password, and database
17name.
18
19> `config.real.maple` also has settings to configure the feel of your beep
20> instance, post length, username length, welcome messages, etc etc.
21
22> **do not put your secrets in `config.maple`**. it is intended to be pushed to
23> git as a "template config." instead, use `config.real.maple` if you plan to
24> push anywhere. it is gitignored already, meaning you do not have to fear about
25> your secrets not being kept a secret.
26
27```sh
28git clone https://github.com/emmathemartian/beep
29cd beep
30v -prod .
31./beep config.real.maple
32```
33
34then go to the configured url to view (default is `http://localhost:8008`).
35
36if you do not have a database, you can either self-host a postgresql database on
37your machine, or you can find a free one online. i use and like
38[neon.tech](https://neon.tech), their free plan is pretty comfortable for a
39small beep instance!