Welcome to GitHub Traffic Analytics! This project is designed to provide detailed analytics for your GitHub repository's traffic, leveraging the power of Next.js and the GitHub REST API. With a sleek and intuitive user interface, it's easier than ever to monitor the popularity and reach of your repositories.
- 🔍 Traffic Insights: Get detailed insights into the number of views and clones of your GitHub repositories.
- 👥 User-Friendly Interface: A beautiful and intuitive interface that makes navigation and usage straightforward.
- 📱 Responsive Design: Fully responsive design that looks great on both desktop and mobile devices.
- 🔗 GitHub API Integration: Utilizes the GitHub REST API to fetch real-time traffic data.
- ⚙️ Easy Setup: Simple installation and setup process, get up and running in minutes.
To get started with GitHub Traffic Analytics, follow these steps:
- Clone this repository to your local machine using
git clone https://github.com/your-username/github-traffic-analytics.git
. - Copy
.env.local.example
to.env.local
and fill in your GitHub API token. - Navigate to the project directory and run
npm install
to install dependencies. - Start the development server by running
npm start
. - Open
http://localhost:3000
in your browser to view the application.
After setting up the project, simply enter the name of your GitHub repository in the app. The application will fetch and display the traffic data, including views and clones, using the GitHub REST API.
Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Please refer to the CONTRIBUTING.md for detailed instructions on how to contribute to this project.
This project is licensed under the MIT License - see the LICENSE file for details.
- This project uses the Next.js framework for server-side rendering and static site generation.
- Traffic data is fetched using the @octokit/rest library.
Thank you for considering GitHub Traffic Analytics for monitoring your GitHub repository traffic!