ClassApp Javascript SDK

This is a SDK of the ClassApp API made for js. It's built with Node.js and TypeScript.

Features

• [x] Built with TypeScript
• [x] Automatic NPM release
• [x] Basic read access to ClassApp data
• [ ] Complete API coverage
• [ ] Unit test coverage

Table of Contents

• Getting Started
  • Prerequisites
  • Installation
  • Using the SDK
  • Running tests
• Project Structure
• Useful Links

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

• Node.js
• npm
• TypeScript

Installation

Note that the installation is meant for development of the SDK. If you plan on using it in a project see the Using the SDK section.

1. Clone the repository:

git clone https://github.com/Jean-Piaget/class-app-js.git
cd class-app-js

2. Install the dependencies:

npm install

Using the SDK

ClassApp API

1. Add the SDK:

npm i @jean-piaget/class-app@latest

2. Create a file for export the client

//( src/lib/classApp.ts )
const classApp = new ClassApp('{{ YOUR_TOKEN }}');

export default classApp;

3. Access all the data you want

const groups = await classApp.getGroups({ limit: 10 });

Running tests

To run the tests, use the following command:

npm test

Project Structure

This project follows a modular structure, organized around the functionality of the application. Here's a brief overview of the main directories and files:

• .github/workflows/: Contains the GitHub Actions workflow files.
• resources/: Contains static files and resources.
• src/: Contains the main source of the API SDK.
  • index.ts: File where the SDK is configured.

note that the tests files MUST be compiled to js before running.

Useful Links

• Node.js
• TypeScript
• Axios
• ClassApp