cyberryteam/epitech-xp-calculator repository overview

⁠epitech-xp-calculator

Epitech XP calculator for the Hub module

⁠Table of Contents

• About⁠
  • Built with⁠
• Getting started⁠
  • Using Docker⁠
    • Prerequisites⁠
  • Using Node.js⁠
    • Prerequisites⁠
    • Installation⁠
• Developing⁠
• Testing⁠
• Using⁠
  • Docker⁠
  • Node.js⁠
• Contributing⁠
• License⁠

⁠About

This program allows Epitech students to know how many XPs they have acquired during their year at Epitech. The XP is necessary to validate a module of discovery and experimentation outside of the courses at Epitech.

⁠Built with

• Docker⁠
• dotenv⁠
• fetch-cookie⁠
• node-fetch⁠

⁠Getting started

⁠Using Docker

⁠Prerequisites

1. Install Docker⁠

⁠Using Node.js

⁠Prerequisites

1. Install Node.js⁠

⁠Installation

1. Clone the repository:

git clone https://github.com/CyberryTeam/epitech-xp-calculator.git
cd epitech-xp-calculator

1. Install Node.js packages:

npm install --production

⁠Developing

git clone https://github.com/CyberryTeam/epitech-xp-calculator.git
cd epitech-xp-calculator

1. Install Node.js packages:

npm install

⁠Testing

Run coding style tests:

npm run lint

⁠Using

• Generate and retrieve your auto-login link⁠.

⁠Docker

docker run --rm -e AUTO_LOGIN=<auto-login> cyberryteam/epitech-xp-calculator:<tag>

Replace <auto-login> by your auto-login link.

Replace <tag> by one of the following:

• tek1: Start date for Tek1
• tek2: Start date for Tek2
• tek3: Start date for Tek3

Note: You can also define the start date by setting the START_DATE variable via the -e option with a value of format yyyy-mm-dd.

⁠Node.js

• Set AUTO_LOGIN variable in the .env file to your auto-login link.
• Start the program:

npm start

Note: You can also define the start date by setting the START_DATE variable in the .env file with a value of format yyyy-mm-dd.

⁠Contributing

Bug reports, feature requests, other issues and pull requests are welcome. See CONTRIBUTING.md⁠ for more information.

Special thanks to Madfish5415⁠ for the activities organization support in XPs counting.

⁠License

Distributed under the MIT⁠ License. See LICENSE⁠ for more information.