EpitechIntranetStatistics

Enhance your Epitech Intranet experience with advanced statistics and visualization.

📍 Overview

EpitechIntranetStatistics is a web application providing statistics and information related to the Epitech Intranet.
It offers functionalities for updating user data, retrieving API information, managing XP points, and displaying charts.
The project aims to enhance the user experience by providing customizable information in an interactive dashboard, facilitating efficient tracking of progress and engagement.

📥 Download

Download from the Chrome Web Store

🔧 Installation

1. Clone the EpitechIntranetStatistics repository:

git clone https://github.com/RedBoardDev/EpitechIntranetStatistics

2. Change to the project directory:

cd EpitechIntranetStatistics

3. Install the dependencies:

npm install

4. Running EpitechIntranetStatistics

npm start

🚧 Want to fix a module code ?

• Create a Pull Request modifying the file public/scripts/data/sortedModules.json with the correct key and value

🤝 Contributing

Contributions are always welcome! Please follow these steps:

1. Fork the project repository. This creates a copy of the project on your account that you can modify without affecting the original project.
2. Clone the forked repository to your local machine using a Git client like Git or GitHub Desktop.
3. Create a new branch with a descriptive name (e.g., new-feature-branch or bugfix-issue-123).

git checkout -b new-feature-branch

4. Make changes to the project's codebase.
5. Commit your changes to your local branch with a clear commit message that explains the changes you've made.

git commit -m 'Implemented new feature.'

6. Push your changes to your forked repository on GitHub using the following command

git push origin new-feature-branch

7. Create a new pull request to the original project repository. In the pull request, describe the changes you've made and why they're necessary. The project maintainers will review your changes and provide feedback or merge them into the main branch.