Metrics

This is a small portal to display metrics. It is built with Next.js and deployed with Vercel.

Can I contribute to / fork this project?

Yes! This project is open source and licensed under the Apache 2.0 license. Feel free to fork this project and make it your own.

What pages are available?

The following pages are available:

• / - The main page, displaying the metrics
• /github/metrics - The metrics section for GitHub.
• /github/topLanguages - The top languages section for GitHub.

Deploying

You can deploy your own instance of this project with Vercel by clicking the button below. You will need to provide your GitHub username and a GitHub Personal Access Token with the repo and user read scopes. From there, you can customise the project to your liking.

Custom

1. Fork this repository
2. Clone your forked repository
3. Copy the .env.example file to .env.local and fill in the required values.
4. Install Bun
5. Run bun install to install the dependencies
6. Run bun dev to start the development server
7. Make any additions or changes you like, such as changing the logo, colours etc.
8. Deploy your changes to a cloud provider of your choice.