This library is not affiliated with ↗ AppScho in any way.

What is "AppScho" ?

↗ AppScho is an all-in-one mobile app which centralizes everything students need - class schedules, grades, campus news, internship offers - into one intuitive platform. Built for universities and higher education institutions, AppScho strengthens engagement and simplifies communication, making campus life more connected and efficient.

Installation

Use your favorite package manager to install this library from the npm registry.

# pnpm
pnpm add appscho

# Yarn
yarn add appscho

# npm
npm add appscho

# Bun
bun add appscho

Quick Start

This library only supports students types as of now. If you want to use it with teachers or other types, please open an issue.

import * as AppScho from "appscho";

// The instance you want to use.
// You can get a list of them by using AppScho.INSTANCES (Array<Instance>) constant.
const instance = "univpoitiers";

const user = await AppScho.login(instance, "username", "password");
console.log(user);

// Retrieve the list of all Crous available for this instance.
const crous = await AppScho.getCrous(instance, user.token);

// Let's retrieve restaurants from the first Crous.
const restaurants = await AppScho.getCrousRestaurants(instance, user.token, crous[0].id);
console.log(restaurants);

You can find guides at ↗ appscho.docs.literate.ink and if it's not enough you can also take a look at the ↗ examples directory on the GitHub repository for inspiration.

If none of those are helpful, you can always ↗ open an issue to ask for help or join the ↗ LiterateInk Discord server.

License

This project is licensed under the GPL-3.0 License - see the LICENSE.md file for details.