Git Product home page Git Product logo

fireflyapi's Introduction

Welcome to the unofficial Firefly API Documentation

Firefly is a virtual learning environment for schools. This repository has been made by monitoring the API requests made by the mobile app on a single pupil user account on a single school instance.

This repository provides a Node.JS driver and example code in Node.JS. You will also need to install the needed modules and libraries using npm install. Please see the wiki for detailed information about the API.

environment.json

You will need to configure environment.json with your own environment data. You can copy environment.example.json to do this.

  • "schoolCode": "SCHOOLCODE" This is the code for the school which is provided by your school. It is needed to determine the host for all other requests, and is used within the mobile app to login.
  • "host": "https://host.fireflycloud.net" This is the base API endpoint which is generally the main page of the Firefly instance. This can be obtained by a school code by submitting an API request - please see the misc section for details.

fireflyapi's People

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.