https://github.com/ivynya/caravel

High-performance, modern client for Canvas LMS - sailed by students, for students.
https://github.com/ivynya/caravel

canvas canvas-lms client pwa

Last synced: about 1 month ago
JSON representation

High-performance, modern client for Canvas LMS - sailed by students, for students.

• Host: GitHub
• URL: https://github.com/ivynya/caravel
• Owner: ivynya
• License: mit
• Created: 2020-09-07T02:45:53.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-06-18T17:40:07.000Z (7 months ago)
• Last Synced: 2024-06-18T22:31:06.068Z (7 months ago)
• Topics: canvas, canvas-lms, client, pwa
• Language: TypeScript
• Homepage: https://caravel.sdbagel.com
• Size: 6.01 MB
• Stars: 6
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![icon-72-72](https://user-images.githubusercontent.com/35588499/175397393-182306fc-1307-4da3-bcaf-e26693dd4278.png)

# Caravel [![CodeQL](https://github.com/ivynya/Caravel/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/ivynya/Caravel/actions/workflows/codeql-analysis.yml)

Caravel is a Canvas client that uses the Canvas Open API. It is designed as an SPA, rather than the MVC-style model that the official Canvas frontend uses. This means Caravel performs ***way faster*** with ***extremely good responsiveness***, especially on ***slow networks*** (found in many schools, public places, and other areas where students may find themselves). It also works offline!

Caravel is also a **PWA** (desktop & mobile) meaning you can take it wherever you go.

## Try It Out

You can try out Caravel with an API token from your account (Profile > Settings > New User Token). You'll also need a CORS-anywhere proxy hosted online (or locally if running Caravel locally as well). These values can be configured on the initial app setup screen.

- https://caravel.sdbagel.com `v0.7.x+` (synced with GitHub)

## Contributing

Contributions of any size are welcome!

For bug reports, please make an [issue](https://github.com/ivynya/Caravel/issues/new/choose) on this repository.

For feature requests, please make an [issue](https://github.com/ivynya/Caravel/issues/new/choose) or post a [discussion thread](https://github.com/ivynya/Caravel/discussions/new) before you start coding - this ensures that duplicate work isn't done and the design is as good as it can be.

For more information, see `CONTRIBUTING.md`.



## Disclaimer

Caravel does not have any official affiliation with Instructure, nor has there been any communication or cooperation. No part of Canvas LMS source code has been used in this application aside from info from public API documentation. Deploying Caravel at scale may present issues as you would need a developer key from your institution to avoid having users paste in API tokens.