Skip to content

LiterateInk/Crowous.js

Crowous: A wrapper for the Crous Mobile internal API

This library is not affiliated with ↗ Les Crous in any way.

What is "Les Crous" ?

↗ Les Crous (or Centres Régionaux des Œuvres Universitaires et Scolaires) in France are regional organizations that provide various services to students to enhance their quality of life.

↗ Les Crous' mobile app facilitates student life by providing access to housing applications, meal plan management, scholarship information, and various support services directly from their smartphones.

Installation

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

# pnpm
pnpm add crowous

# Yarn
yarn add crowous

# npm
npm add crowous

# Bun
bun add crowous

Quick Start

import * as crous from "crowous";

// Note that you don't have to be authenticated to use this library.
const feeds = await crous.feeds();

// Let's list all the feeds !
for (const feed of feeds) {
  console.log(`${feed.name} (${feed.identifier})`);
}

You can find guides at ↗ crowous.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.

Sponsor this project