hy37id / realtime_example

Realtime

The Elixir backend for Realtime.

About Realtime

TODO: Briefly describe what Realtime does

Scripts

bin/setup

Bash script that sets up the project, its dependencies, seeds, and runs bin/test to verify everything is working. You should run this script on the CI server.

bin/test

Bash script which runs all the tests for the project. For example: credo, dialyzer, compile --warnings-as-errors, run tests.

bin/update

Bash script which git pulls, updates dependencies, runs migrations, etc. It makes it easy for a mobile developer to pull down and update everything.

bin/reset

Bash script which resets everything and reruns bin/setup again.

mix docs

Generates ExDoc documentation for the project.

Architecture

Realtime uses the Mithril code organization conventions.

• apps/realtime contains the business logic for the application. See its README and docs for details on its public API.
• apps/realtime_api provides a GraphQL API.
• apps/realtime_web contains a simple Phoenix application, which wraps the business logic from apps/realtime.

TODO: describe other apps