bloat/README

bloat - A web client for Mastodon Network[1]

Features:

- Does not require JavaScript to display text, images, audio and videos.


Requirements:

- Go 1.11


External dependencies:

- Fork of go-masodon (https://github.com/mattn/go-mastodon)
- gorilla/mux (https://github.com/gorilla/mux)


Building and Installation:

Make sure you have GO installed. Other dependencies will be downloaded 
automatically.

Typing make will build the binary 
$ make

Edit the provided config file. See the default.conf file for more details.  
$ ed default.conf

Run the binary
$ ./bloat

You can now access the frontend at http://localhost:8080, which is the default
listen address. You can also setup a reverse HTTP proxy to serve the frontend over
TLS connection.


Notes:

A database reset is required after changing the values of config options client_name,
client_scope or client_website.


License:

To the extent possible under law, the author have dedicated all copyright and
related and neighboring rights to this software to the public domain worldwide.
This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along with
this software. If not, see http://creativecommons.org/publicdomain/zero/1.0/.


[1] https://pleroma.social