README.md

README

API for getting student points from the TMC API, and passing them on to the dashboard frontend.

• Ruby version 2.3.1, Rails v5.0.4

How to set it up

TODO: more detail, but essentially this:

• download to a server
• bundle install
• check conf settings in config/application.rb and config/environments/production.rb
• bin/rails db:migrate
• bin/rails db:seed
• bin/rails server

How it works

See the main documentation.

Maybe this picture is of use:

╔═══════════════╗                              ╔════════════╗
║               ║                              ║            ║
║  Course page  ║◁────────────────────────────▷║ TMC server ║
║               ║                              ║            ║
║               ║                              ╚════════════╝
║ ┏━━━━━━━━━━━┓═╝        ╔══════════════╗            △
║ ┃ Dashboard ┃          ║   Backend    ║            │
║ ┃ frontend  ┃◁────────▷║(this project)║◁───────────┘
║ ┗━━━━━━━━━━━┛═╗        ║              ║
╚═══════════════╝        ╚══════════════╝