https://github.com/goelbenj/uoft-canvas-api
A NodeJS high-level API to call down to Canvas LMS - REST API
https://github.com/goelbenj/uoft-canvas-api
api-rest instructure-canvas node uoft
Last synced: 5 months ago
JSON representation
A NodeJS high-level API to call down to Canvas LMS - REST API
- Host: GitHub
- URL: https://github.com/goelbenj/uoft-canvas-api
- Owner: goelbenj
- License: mit
- Created: 2021-02-18T00:45:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-19T03:01:33.000Z (over 5 years ago)
- Last Synced: 2025-09-14T14:57:58.229Z (9 months ago)
- Topics: api-rest, instructure-canvas, node, uoft
- Language: JavaScript
- Homepage:
- Size: 113 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://standardjs.com)
[](https://github.com/facebook/jest)
# Canvas LMS API for Node.js
Canvas API functions bundled as a NPM package for Node.js.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for use with your own API tokens and Canvas domains.
### Prerequisites
1. **Install [Node 8.0.0 or greater](https://nodejs.org)**.
### Installation
To use with node:
```bash
$ npm install uoft-canvas-api
```
Then, in wherever you want to use this package:
```js
const canvasAPI = require('uoft-canvas-api')
```
Rename the `sample.env` file to `.env` and add your institution's domain and API access token.
#### For UofT:
```
CANVAS_API_TOKEN={YOUR_TOKEN_FROM_QUERCUS}
CANVAS_API_DOMAIN=https://q.utoronto.ca/api/v1
```
Attached to the `canvasAPI` are a [bunch of functions](https://github.com/goelbenj/uoft-canvas-api/tree/master/src).
Run the attached functions!
### Example Usage
#### Get information about self:
```js
const canvasAPI = require('uoft-canvas-api')
canvasAPI.getSelf()
.then(self => console.log(self))
```
#### Get students in a course:
```js
const { getUsersInCourse, getOptions } = require('uoft-canvas-api')
getUsersInCourse(12345, getOptions.users.enrollmentType.student) // first argument is Canvas course ID
.then(students => console.log(students))
```
## Contribute
Contributions are welcome and greatly appreciated!
### How to contribute
1. Create an [issue](https://github.com/goelbenj/uoft-canvas-api/issues) describing what contribution you are planning to make.
1. Fork the repo.
1. Add your contributions to the [`source` directory](https://github.com/goelbenj/uoft-canvas-api/tree/master/source) (and not the `src` directory. This directory is generated by [Rollup](https://rollupjs.org/guide/en/) during the build phase, and is what gets published to [npm](https://www.npmjs.com/package/uoft-canvas-api).)
1. If you add a file to `source`, please add the file to the existing [`index.js` inside `source`](https://github.com/goelbenj/uoft-canvas-api/blob/master/source/index.js), so that during the build your contribution will be included in `src`.
1. Test your code by creating a file in the root of the project directory, importing your code addition from `src`, and running it.
1. Once you're happy with your contribution, open an [pull request](https://github.com/goelbenj/uoft-canvas-api/pulls) and I'll take a look.
### Hypothetical scenario for adding new feature
1. Add new file to `source` folder (say that the new file you want to add is `getUsersWithGradeThreshold.js`)
2. In the `source` folder, there’s an `index.js` file that lists all of the files you want exported to `src`. There you will add: `export { default as getUsersWithGradeThreshold } from './getUsersWithGradeThreshold'`
3. Run `npm run build`, which will build the project and output your new function into `src`.
4. In the `index.js` at the root of the project that you create (this is not the `index.js` that’s in the `source` folder), import your new file from `src` like this: `const getUsersWithGradeThreshold = require('.src/getUsersWithGradeThreshold')` and test by running the code: `node index.js`.
5. Once you’re happy that it works, create a PR.
## Authors
* [goelbenj](https://github.com/goelbenj) -
**Benjamin Goel** <benjamin.goel@mail.utoronto.ca>
## License
This project is licensed under the MIT License.