Contributing

Glad you want to help! Mutual aid is ~~a factor of evolution~~ punk rock as it gets.

You may want to look at

Don't hesitate to contact if you need help, or want to discuss something before.

Setup

MeroChat is written in PureScript, both server-side and client-side. PostgreSQL is used for persistance.

You can run MeroChat locally with docker

Run sudo docker-compose -f dockerfile.yml up to spin up the containers
When prompted, run sudo docker exec -w /merochat -i merochat start-spago and sudo docker exec -w /merochat -i merochat start-npm in two separate terminals

...or set it up manually

Run npm install && spago build
Configure PostgreSQL and run index.sql. The user merochat, databases merochat and merochat_test are expected (ident or trust authentication)
Run npm run watch to start a server at http://localhost:8000
- purescript-ide is the fast and easy way to rebuild the project. Alternatively, run spago build --watch in a new terminal
- Refresh the page after any changes :)

Unless it is a small change, please include tests and a clear commit message. Bonus points if the code has documentation comments.