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 podman or docker. The following uses podman, but you can substitute docker-compose in ther too.

Run podman-compose -f containers/composefile.yaml up to spin up the containers. Wait a moment for the containers to build.
Your very own MeroChat is now accessible at http://localhost:8000, and will be rebuilt when you make changes to the code. This isn't instantaneous though. Keep an eye at the container runtime output.
Finally tear the containers down with ctr+c followed by podman-compose -f containers/composefile.yaml down

No containers for you?

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.