https://github.com/emmathemartian/beep
A self-hosted mini-blogger
https://github.com/emmathemartian/beep
Last synced: 3 months ago
JSON representation
A self-hosted mini-blogger
- Host: GitHub
- URL: https://github.com/emmathemartian/beep
- Owner: EmmaTheMartian
- License: mit
- Created: 2024-12-12T14:26:56.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-01-08T04:21:45.000Z (5 months ago)
- Last Synced: 2025-01-08T05:22:14.587Z (5 months ago)
- Language: V
- Size: 159 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license.txt
Awesome Lists containing this project
README
# beep
> *a legendary land of lowercase lovers.*
a self-hosted "social-media-oriented" mini-blogger.
technically made because i wanted to mess around with rss, but i also wanted a
teensy little blog/slow-paced-chat-app for myself and my friends.
## hosting
you will need a postgresql database somewhere, along with v to compile beep:
copy the `config.maple` as `config.real.maple`
edit `config.real.maple` to set the url, port, username, password, and database
name.
> `config.real.maple` also has settings to configure the feel of your beep
> instance, post length, username length, welcome messages, etc etc.
> **do not put your secrets in `config.maple`**. it is intended to be pushed to
> git as a "template config." instead, use `config.real.maple` if you plan to
> push anywhere. it is gitignored already, meaning you do not have to fear about
> your secrets not being kept a secret.
```sh
git clone https://github.com/emmathemartian/beep
cd beep
v -prod .
./beep config.real.maple
```
then go to the configured url to view (default is `http://localhost:8008`).
if you do not have a database, you can either self-host a postgresql database on
your machine, or you can find a free one online. i use and like
[neon.tech](https://neon.tech), their free plan is pretty comfortable for a
small beep instance!