WeMe-Api

Elixir API for handling connections and messages for WeMe App.

Installing / Getting started

To run this project, you will need to install the following dependencies on your system:

• Elixir
• Erlang/OTP 20.0
• Phoenix
• PostgreSQL

To get started, run the following commands in your project folder:

mix deps.get  # installs the dependencies
mix ecto.create  # creates the database.
mix ecto.migrate  # run the database migrations.
mix phx.server  # run the application.

Tests

To run the tests for this project, simply run in your terminal:

mix test

Documentation

To generate the documentation, your can run in your terminal:

mix docs

This will generate a doc/ directory with a documentation in HTML. To view the documentation, open the index.html file in the generated directory.

Style guide

This project uses mix format. You can find the configuration file for the formatter in the .formatter.exs file.