A dashboard application built with React to display GitLab statistics using GitLab APIs, including merge requests, project details, and issue timelines.
This dashboard application uses the GitLab API to provide statistics on closed issues, merge requests, and project details for a specific assignee. Data is visualized with React components and Chart.js. The idea behind this dashboard is to serve as a portfolio piece, allowing developers to showcase their projects, languages used, and relevant statistics, making it a valuable resource for job interviews by highlighting the developer's skills and experience.
-
React: The entire project is built using React, taking advantage of its component-based architecture for a modular and scalable codebase.
-
ESLint and Stylelint: Code quality is maintained through the integration of ESLint for JavaScript and Stylelint for styles. This ensures adherence to best practices and coding standards.
-
Clone the repository:
git clone https://github.com/GianMen91/gitlab-statistics.git
-
Install dependencies:
npm install
-
Get or create your GitLab access token
- Log in to your GitLab account.
- Navigate to your profile settings by clicking on your avatar in the top right corner and selecting Settings.
- In the left sidebar, click on Access Tokens.
- Give your token a name, select the desired scopes (e.g., API), and click Create personal access token.
- Copy the generated token and keep it safe. You'll need it for the next step.
Open the project in your preferred code editor and navigate to the App.js file. Replace the placeholder access token with your actual GitLab access token:
`const ACCESS_TOKEN = 'your-access-token'; // Replace 'your-access-token' with your actual GitLab access token`
-
Start the development server:
npm start
-
Open http://localhost:3000 in your browser to view the application.
- Upon loading the application, it will fetch data from the GitLab API and display statistics about closed issues, merge requests, and project details for the specified assignee.
- The dashboard provides a clean and organized interface for recruiters to view the assignee's contributions and project involvement.
Contributions from users are highly valued and appreciated. Two main ways to contribute to this project are through pull requests and issues.
- Fork the repository and create a branch from the
main
branch. - Make changes or additions to the code.
- Commit the changes, and push them to the branch.
- Open a pull request to the
main
branch with a clear and concise description of the changes.
- Navigate to the Issues section of the repository.
- Check if there is an existing issue similar to the one you'd like to create.
- If there isn't an existing issue, create a new issue by clicking the "New issue" button.
- Provide a descriptive title and detailed information about the proposed changes you want to add to the current script.
Feel free to contribute and share
Use nvm install v22.2.0 in case of an error
This project is licensed under the MIT License - see the LICENSE file for details.