james/classcharts-api-js
1
0
Fork 0
mirror of https://github.com/classchartsapi/classcharts-api-js.git synced 2026-05-14 11:58:13 +00:00
Code Activity

feat: New docs! (#28)

Browse source
This commit is contained in:
James 2023-05-04 21:56:19 +01:00 • committed by GitHub
parent c3315ad054
commit 9382479ab6
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 340 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

36
readme.md
View file

@ -1,29 +1,23 @@
# Classcharts API
<h1 align="center">Classcharts API</h1>
<div align="center">
<img alt="Discord" src="https://img.shields.io/discord/918103752068726855">
<img alt="npm" src="https://img.shields.io/npm/dm/classcharts-api">
<img alt="NPM" src="https://img.shields.io/npm/l/classcharts-api">
<img alt="npm" src="https://img.shields.io/npm/v/classcharts-api">
<img alt="node-current" src="https://img.shields.io/node/v/classcharts-api">
</div>
A client for the classcharts API
<p align="center">A typescript wrapper for getting information from the Classcharts API.</p>
# Links
- [Documentation](https://classchartsapi.github.io/classcharts-api-js/)
- [API Documentation (with library examples)](https://classchartsapi.github.io/api-docs/#introduction)
- [Discord](https://discord.gg/DTcwugcgZ2)
# Examples
# Contributing
Docs are very much a WIP, for any help with the library, please join the discord above
Contributions are welcome! There are lots of API endpoints which we simply do not have access to to implement, so if you have access to them, please consider contributing! If you have any questions, feel free to ask in the [discord](https://discord.gg/DTcwugcgZ2).
```typescript
import { StudentClient } from "classcharts-api";
async function main() {
const client = new StudentClient("classchartsCode", "01/1/2000");
await client.login();
console.log(
await client.getBehaviour({
from: "20/01/2000",
to: "01/02/2000",
})
);
console.log(await client.getActivity());
console.log(await client.getStudentInfo());
}
# Help
main();
```
For any help with the library, please join the [discord](https://discord.gg/DTcwugcgZ2) where you can ask questions and get help from the community.