Skip to content

Latest commit

 

History

History
executable file
·
158 lines (107 loc) · 5.78 KB

README.md

File metadata and controls

executable file
·
158 lines (107 loc) · 5.78 KB
Raw

FlowChat — An open-source, self-hostable reddit alternative featuring communities and live-updating threaded conversations.

Build Status

FlowChat is an open-source, self-hostable reddit alternative. It has communities, hashtags, live-updating threaded conversations, and voting.

Flowchat tries to solve the problem of having a fluid, free-feeling group chat, while allowing for side conversations so that every comment isn't at the top level, and doesn't disrupt the flow.

Multiple conversations can take place at once, without interrupting the flow of the chatroom.

Check out the default community, vanilla, or create your own.

It features:

  • Private or public discussions and communities.
  • Sorting by recentness, hotness, or popularity.
  • Antiracist policies including a global slur filter (No racism will be allowed on the main Flowchat instance).
  • Image and video focused, with auto-zoom.
  • Moderation including blocking users, appointing moderators, or deleting comments.
  • NSFW filtering.
  • Stickied posts.
  • Hashtags.

Tech used:

Check out a sample discussion here.

Join the community: flowchat

Change log

screen1

screen2

Installation

If you want to self-host or develop flowchat.

Docker

Requirements

  • Docker
  • docker-compose

Start the docker instance

git clone https://github.com/dessalines/flowchat
cd flowchat
// edit ARG ENDPOINT_NAME=http://localhost:4567 in ./Dockerfile to your hostname
docker-compose up

Goto to http://localhost:4567

Local development

Requirements

  • Java 8 + Maven
  • Node + npm/yarn, nvm is the preferred installation method.
  • angular-cli: npm i -g @angular/cli
  • Postgres 9.3 or higher

Download Flowchat

git clone https://github.com/dessalines/flowchat

Setup a postgres database

Here are some instructions to get your postgres DB up and running.

psql -c "create user flowchat with password 'asdf' superuser"
psql -c 'create database flowchat with owner flowchat;'

Edit your pom.xml file to point to your database

cd flowchat
vim service/flowchat.properties

Edit it to point to your own database:

<!--The Database location and login, here's a sample-->
jdbc.url=jdbc\:postgresql\://127.0.0.1/flowchat
jdbc.username=flowchat
jdbc.password=asdf
sorting_created_weight=86400
sorting_number_of_votes_weight=0.001
sorting_avg_rank_weight=0.01
reddit_client_id=
reddit_client_secret=
reddit_username=
reddit_password=

Install flowchat

for local testing:

./install_dev.sh and goto http://localhost:4567/

for front end angular development, do:

cd ui
ng serve

and goto http://localhost:4200

for a production environment, edit ui/config/environment.prod.ts to point to your hostname, then run:

./install_prod.sh

You can redirect ports in linux to route from port 80 to this port:

sudo iptables -t nat -I PREROUTING -p tcp --dport 80 -j REDIRECT --to-ports 4567

Bugs and feature requests

Have a bug or a feature request? If your issue isn't already listed, then open a new issue here.