a mini social media app for small communities

update readme and add a cloc task to build.maple for funsies

Changed files
+19 -8
+7
build.maple
··· 54 54 category = 'run' 55 55 run = '${v} -d veb_livereload watch run ${v_main} config.real.maple' 56 56 } 57 + 58 + task:cloc = { 59 + description = 'Get the lines of code for beep!' 60 + category = 'misc' 61 + //todo: contribute vlang support to cloc and use that here instead of it seeing all of our v code as verilog code 62 + run = 'cloc ./src/' 63 + }
+12 -8
readme.md
··· 2 2 3 3 > *a legendary land of lowercase lovers.* 4 4 5 - a self-hosted mini-blogger. 5 + a self-hosted "social-media-oriented" mini-blogger. 6 6 7 7 technically made because i wanted to mess around with rss, but i also wanted a 8 8 teensy little blog/slow-paced-chat-app for myself and my friends. ··· 11 11 12 12 you will need a postgresql database somewhere, along with v to compile beep: 13 13 14 - edit `config.maple` to set the url, port, username, password, and database name. 14 + copy the `config.maple` as `config.real.maple` 15 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. 16 + edit `config.real.maple` to set the url, port, username, password, and database 17 + name. 18 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. 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. 22 26 23 27 ```sh 24 28 git clone https://github.com/emmathemartian/beep 25 29 cd beep 26 30 v -prod . 27 - ./beep config.maple 31 + ./beep config.real.maple 28 32 ``` 29 33 30 34 then go to the configured url to view (default is `http://localhost:8008`).