Muhokama (which means "discussion" in Uzbek) is a web application that powers a rudimentary forum because Slack, Discord and IRC are, in our opinion, not very suitable for long conversations and message tracking.
Muhokama is an OCaml application (>= 4.13.1), so it
needs to be installed.
And for lack of originality the application is based on a
PostgreSQL database (which must be installed and
properly configured). For the sake of comfort,
GNU/Make is an optional but recommended
addiction. (All examples in this tutorial assume that make is available).
Once the repository is locally cloned, go to the root of the project. To locate all dependencies at the root of the project (locally) rather than globally, creating a local switch is recommended:
opam update
opam switch create . ocaml-base-compiler.4.14.0 --deps-only -y
eval $(opam env)When the local switch build procedure is complete you can simply run the following two commands to retrieve the project dependencies and to retrieve the development dependencies (the second one is optional):
make deps
make dev-depsAssuming a role has been created for the current user, you can simply issue the
command make init-database which will create a user muhokama and and ask for
a password to be entered in a prompter, and two databases:
muhokama_dev: the database populated by the development server to test the application locally;muhokama_test: the database used for the integration tests.
The configuration is provisioned by environment variables:
export PGSQL_HOST=localhost
export PGSQL_PORT=5432
export PGSQL_DB=muhokama_dev
export PGSQL_USER=muhokama
export PGSQL_PASS=muhokama
export LOG_LEVEL=debug
export PGSQL_CONNECTION_POOL=20Running integration tests (with the make test-integration command) requires
the presence of a .test_env file at the root of the project which exports
environment variables specific to running integration tests.
The main actions are orchestrable via the muhokama.exe binary. Once the
project is compiled (using, for example, make build) it is impossible to
invoke the tool with ./bin/muhokama.exe PARAMS or dune exec bin/muhokama.exe -- PARAMS. The second invocation recompiles (if needed) the binary. Each
subcommand can display its man page using the --help flag.
| Invocation | Description |
|---|---|
./bin/muhokama.exe |
Displays the man page of the binary |
./bin/muhokama.exe db.migrate |
Builds a migration context and performs missing migrations. (For example, if the migration context is 2 and there are migrations 3, 4, and 5, the invocation will execute migration 3, 4, and 5 if migration 2 has the same hash as migration 2 that was executed.) |
./bin/muhokama.exe db.migrate --to N |
Replaces the migration state according to the given parameter N. If for example the current state is 5, ./bin/muhokama.exe db.migrate --to 2 will play 5.down, 4.down and 3.down. If, on the other hand, the current state is 0, 1.up, and 2.up will be played. If no error has occurred, the state must be the argument given to --to. |
./bin/muhokama.exe db.migrate.reset |
Removes the migration context (in database). . |
./bin/muhokama.exe server.launch |
Starts the application on the default port (4000). It is possible to add the --port X flag to change this value. |
.bin/muhokama.exe user.list |
Lists all registered users (regardless of their status) |
.bin/muhokama.exe user.set-state -U USER_ID -S USER_STATE |
Changes the status (inactive, member, moderator admin) of a user via its ID ( UUID ). |