intra-epitech-client

Description

This is a client for the intra-epitech API. It is written in TypeScript and is meant to be used in a NodeJS environment.

The goal of this project is to provide a simple and easy to use client for the intra-epitech API in order to make it easier for epitech students to create their own tools without having to worry about the API (which is not documented).

Features

EpitechClient is still in development. Here is a list of the features that are already implemented and the ones that are planned.

• [x] Get student infos
• [x] Get elearning infos/videos
• [x] Get student planning
• [x] Get student notifications
• [x] Get student modules
• [ ] Get student projects
• [ ] Get student marks
• [ ] Access to the intra filesystem

Installation

npm install intra-epitech-client

Usage

Usage with cookie in environment variable

Add a environment variable named EPITECH_COOKIE with the value of your intra cookie.

import EpitechClient from 'intra-epitech-client';

const client = new EpitechClient();

client.user.getStudentName().then((name) => {
    console.log(name);
});

Usage with cookie in constructor

import EpitechClient from 'intra-epitech-client';

const client = new EpitechClient('your cookie');

client.user.getStudentName().then((name) => {
    console.log(name);
});

Documentation

Documentation is available here.

Contributing

If you want to contribute to this project, feel free to fork it and submit a pull request. I will review it as soon as possible. If you have any questions, you can contact me by email at [email protected].

You can also open an issue if you find a bug or if you have a feature request.

Run tests

npm test

Run linter

npm run lint

Run linter and fix errors

npm run lint:fix

Run in dev environment

npm run dev (nodemon required)