https://github.com/literateink/crowous.js
A JS/TS wrapper for the Crous Mobile internal API.
https://github.com/literateink/crowous.js
api crous crous-mobile france les-crous restaurant student university wrapper
Last synced: 4 months ago
JSON representation
A JS/TS wrapper for the Crous Mobile internal API.
- Host: GitHub
- URL: https://github.com/literateink/crowous.js
- Owner: LiterateInk
- License: gpl-3.0
- Created: 2024-06-14T11:31:10.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-27T23:08:14.000Z (4 months ago)
- Last Synced: 2025-06-20T14:16:18.688Z (4 months ago)
- Topics: api, crous, crous-mobile, france, les-crous, restaurant, student, university, wrapper
- Language: TypeScript
- Homepage: https://crowous.docs.literate.ink/
- Size: 266 KB
- Stars: 6
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Citation: CITATION.cff
Awesome Lists containing this project
README
_This library **is not** affiliated with [↗ Les Crous](https://www.lescrous.fr/) in any way._
## What is "Les Crous" ?
[↗ Les Crous](https://www.lescrous.fr/) (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](https://play.google.com/store/apps/details?id=com.einden.crous.poitiers.android) 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.
```bash
# pnpm
pnpm add crowous
# Yarn
yarn add crowous
# npm
npm add crowous
# Bun
bun add crowous
```
## Quick Start
```typescript
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**](https://crowous.docs.literate.ink) and if it's not enough you can also take a look at the [**↗ examples** directory on the GitHub repository](https://github.com/LiterateInk/Crowous.js/tree/main/examples) for inspiration.
If none of those are helpful, you can always [↗ open an issue](https://github.com/LiterateInk/Crowous.js/issues) to ask for help or join the [↗ LiterateInk Discord server](https://literate.ink/discord).
## License
This project is licensed under the GPL-3.0 License - see the [LICENSE.md](LICENSE.md) file for details.