Cadet is the web application powering Source Academy.
- Elixir 1.6
- Erlang/OTP 21
- PostgreSQL (>= 9.6)
- Install Elixir dependencies
$ mix deps.get
- Initialise development database
$ mix ecto.setup
- 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
, andguest_password
is required for the application to run with the--updater
flag. Otherwise, the default values will suffice.
- Run the server in your local machine
$ mix phx.server
- 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.
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
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.
MIT