schoolsoft
v2.1.0
Published
Unofficial reverse enginereed SchoolSoft API
Downloads
4
Maintainers
Readme
node-schoolsoft
A SchoolSoft API wrapper for both the browser and Node.js!
Features
- Zero dependencies!
- Built with TypeScript and comes with types!
- Utilises the native
fetch
API!- Works with the browser, Node.js v18+, and frameworks that implement the
fetch
API like Next.js!
- Works with the browser, Node.js v18+, and frameworks that implement the
- Uses ESM instead of CommonJS!
Disclaimer
This library has not been tested with guardian nor staff accounts, so please be aware that it's highly unlikely they will work with this API wrapper.
Installation
npm i schoolsoft
Documentation
No documentation yet, but check out the source code
and the testing file
for all methods available.
Testing
Testing is implemented with jest
. Here's how to run the test cases:
Create a
.env
file with the environment variables found in__tests__/environment.d.ts
in the root directory.Run the test cases with
npm test
.
Credits
Thank you to this repository for giving me a head start.