README.md

BoE /bō/

A chat platform that intends to look at other chat programs and take only the "Best of Everything".

^{Icon by angelgal246.}

Goals:

Development:

Anyone is welcome to contribute to the project. You can check the projects page to see what is not currently being done.

Any commit must pass the following:

• golint
• go vet
• gofmt
• go test- Not implemented yet

Setup:

After you clone the repository you need to clone the submodules with:

git submodule init
git submodule update

Then run make setup, which will automatically run go get for you to grab all of the dependencies.

Building:

To build to everything run make build.

Running:

To run the server in the development environment run make run.

Docker Database:

The make file includes a docker mongo database. If you already have a database hosted on your computer, you can use that instead. To start the database run start-database.
To stop it run stop-database.