GitHub Analytics Dashboard is a web application that provides insights into your GitHub profile. It displays information about your repositories, commits, pull requests, issues, and more. The dashboard is built using Next.js, Tailwind CSS, and the GitHub API.
Follow these instructions to get the project up and running on your local machine.
You need to have the following software installed on your computer:
Star the repository.
Clone this repository to your local machine using the following command:
git clone https://github.com/nixrajput/github-analytics.git
Navigate to the project directory:
cd github-analytics
Install the project dependencies:
If you're using npm:
npm install
If you're using pnpm:
pnpm install
If you're using Yarn:
yarn install
If you're using Bun:
bun install
Create a .env.local
file in the root directory of the project and add the following environment variables:
NEXT_PUBLIC_GITHUB_USERNAME=your-github-username
NEXT_PUBLIC_GITHUB_TOKEN=your-github-access-token
NEXT_PUBLIC_EMAIL_USERNAME=your-email-username
NEXT_PUBLIC_EMAIL_PASSWORD=your-email-password
NEXT_PUBLIC_EMAIL_HOST=your-email-host
NEXT_PUBLIC_EMAIL_PORT=your-email-port
NEXT_PUBLIC_EMAIL_SECURE=your-email-secure
NEXT_PUBLIC_EMAIL_FROM=your-email-from
NEXT_PUBLIC_EMAIL_TO=your-email-to
Replace the placeholder values with your GitHub username, GitHub access token, email credentials, and email addresses. You can create a GitHub access token by following the instructions in the GitHub documentation.
To start the development server and view the website locally, run the following command:
npm run dev
#or
pnpm run dev
# or
yarn dev
# or
bun dev
This will start the Next.js development server, and you can access the website in your web browser at http://localhost:3000
.
To deploy the portfolio website to a hosting service of your choice, follow the deployment instructions for Next.js applications. Some popular hosting options include Vercel, Netlify, and GitHub Pages.
Remember to configure environment variables for sensitive information like email credentials if needed.
If you would like to contribute to this project, feel free to fork the repository, make your changes, and submit a pull request. Please follow the guidelines in the CONTRIBUTING.md file.
This project is licensed under the MIT License - see the LICENSE file for details.
Your support helps me dedicate more time to developing high-quality, impactful projects in the open-source community. Sponsor me, and together, let’s bring even more innovation to life!