https://github.com/connoratherton/progress

Progress.js is an online tool that allows students to visualise and forecast academic grades
https://github.com/connoratherton/progress

Last synced: about 1 month ago
JSON representation

Progress.js is an online tool that allows students to visualise and forecast academic grades

• Host: GitHub
• URL: https://github.com/connoratherton/progress
• Owner: ConnorAtherton
• Created: 2013-07-27T13:05:41.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-11-19T23:10:53.000Z (almost 11 years ago)
• Last Synced: 2024-04-14T20:10:33.867Z (7 months ago)
• Language: JavaScript
• Homepage:
• Size: 3.74 MB
• Stars: 13
• Watchers: 6
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Progress.js

Progress is an online tool that allows students to visualise and forecast academic grades

## Usage

Link progress.js file into your project

```HTML

```

Create container for progress to load graphs into.

**IMPORTANT** The container needs to have an ```id``` so progress can find it. It also needs to have a ```data-user-id``` attribute which is the users unique identifier to retrieve data from RESTful API

```HTML

```

Initalise progress by calling `progress.init()` passing in the container ```id``` as the first argument and link to the API where the student data is served as the second argument

```JavaScript

progress.init("data", "path/to/RESTful/API")

```

Watch the magic happen.

## Installing the demo

Navigate into the ```demo``` directory.

Install node modules

  

	npm install

Install bower dependencies

  

    bower install

Run the server

  

    grunt server

The demo should automatically open in your browser - now just hack away and contribute!

## Contributing

1. Fork it

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Added some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create new Pull Request