Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 1.38 KB

README.md

File metadata and controls

32 lines (23 loc) · 1.38 KB
Raw

Firefly Assistant

Docker Cloud Automated build Docker build

Available at https://firefly.joshheng.co.uk

Firefly Assistant is an unofficial service for the Firefly Learning school platform that enables you to convert your timetable into a live iCalendar file (so it can be shown in your own calendar, e.g. on your phone)

Please note that this service is not affiliated in any way with Firefly Learning.

See the Firefly API for more information about the API itself

Running

Dependencies

  • MongoDB
  • Node.JS

Environment Variables

  • DOMAIN - domain of the instance
  • MONGOURL - url (including db name) of the MongoDB database
  • SECRET - secret
  • PORT - port (defaults to 3000)
  • SECRETKEY - 32 byte hex secret that can be generated with generateSecretKey.js

Nodemon

  1. Install dependencies with npm install
  2. Start nodemon with npm start

Docker

This is available on Docker Hub at joshheng/fireflyassistant

To build, run docker build --tag fireflyassistant:latest . To run, run docker run -p 3001:3001 --name=fireflyassistant -e DOMAIN=domain [-e etc] fireflyassistant