Skip to content

Latest commit

 

History

History
77 lines (51 loc) · 2 KB

README.md

File metadata and controls

77 lines (51 loc) · 2 KB
Raw

Cadet

Build Status Coverage Status Inline docs

Cadet is the web application powering Source Academy.

Developer Setup

System Requirements

  1. Elixir 1.6
  2. Erlang/OTP 21
  3. PostgreSQL (>= 9.6)

Setting Up Local Development Environment

  1. Install Elixir dependencies
$ mix deps.get
  1. Initialise development database
$ mix ecto.setup
  1. Setup the developement secrets (replace the values appropriately)
$ cp config/secrets.exs.example config/secrets.exs
$ vim config/secrets.exs
  • A valid ivle_key is required for the application to properly authenticate with IVLE.
  • A valid cs1101s_repository, cs1101s_rsa_key, guest_username, and guest_password is required for the application to run with the --updater flag. Otherwise, the default values will suffice.
  1. Run the server in your local machine
$ mix phx.server
  1. You may now make API calls to the server locally via localhost:4000. The API documentation can also be accessed at http://localhost:4000/swagger.

Obtaining access_token in dev environment

You can obtain access_token JWT of a user with a given role by simply running:

$ mix cadet.token <role>

For more information, run

$ mix help cadet.token

Style Guide

We follow this style guide: https://github.com/lexmag/elixir-style-guide and https://github.com/christopheradams/elixir_style_guide

Where there is a conflict between the two, the first one (lexmag) shall be the one followed.

Entity-Relationship Diagram

Last generated on 13 September 2018

Entity-Relationship Diagram for cadet

License

MIT