|
| 1 | +# GitHub Analytics |
| 2 | + |
| 3 | +A dashboard for visualizing GitHub repository data and activity. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +- Repository statistics and metrics |
| 8 | +- Activity timeline |
| 9 | +- Commit history visualization |
| 10 | +- Issue tracking |
| 11 | +- GitHub Actions workflow monitoring |
| 12 | + |
| 13 | +## Setup |
| 14 | + |
| 15 | +1. Clone the repository |
| 16 | + ```bash |
| 17 | + git clone https://github.com/yourusername/github-analytics.git |
| 18 | + cd github-analytics |
| 19 | + ``` |
| 20 | + |
| 21 | +2. Install dependencies |
| 22 | + ```bash |
| 23 | + npm install |
| 24 | + ``` |
| 25 | + |
| 26 | +3. Set up environment variables |
| 27 | + - Copy `.env.example` to `.env.local` |
| 28 | + ```bash |
| 29 | + cp .env.example .env.local |
| 30 | + ``` |
| 31 | + - Edit `.env.local` and add your GitHub token |
| 32 | + |
| 33 | +4. Run the development server |
| 34 | + ```bash |
| 35 | + npm run dev |
| 36 | + ``` |
| 37 | + |
| 38 | +5. Open [http://localhost:3000](http://localhost:3000) in your browser |
| 39 | + |
| 40 | +## Environment Variables |
| 41 | + |
| 42 | +- `GITHUB_TOKEN`: A GitHub personal access token with repo scope |
| 43 | +- `NEXT_PUBLIC_SOCKET_URL`: URL for WebSocket connection (only needed if using real-time features) |
| 44 | + |
| 45 | +## Deployment on Vercel |
| 46 | + |
| 47 | +1. Push your code to GitHub |
| 48 | +2. Import the project in Vercel |
| 49 | +3. Add the environment variables in the Vercel project settings |
| 50 | +4. Deploy! |
| 51 | + |
| 52 | +## Technologies Used |
| 53 | + |
| 54 | +- Next.js |
| 55 | +- Material UI |
| 56 | +- Recharts |
| 57 | +- Tailwind CSS |
| 58 | +- GitHub APIThis is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app). |
| 59 | + |
| 60 | +## Getting Started |
| 61 | + |
| 62 | +First, run the development server: |
| 63 | + |
| 64 | +```bash |
| 65 | +npm run dev |
| 66 | +# or |
| 67 | +yarn dev |
| 68 | +# or |
| 69 | +pnpm dev |
| 70 | +# or |
| 71 | +bun dev |
| 72 | +``` |
| 73 | + |
| 74 | +Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. |
| 75 | + |
| 76 | +You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. |
| 77 | + |
| 78 | +This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel. |
| 79 | + |
| 80 | +## Learn More |
| 81 | + |
| 82 | +To learn more about Next.js, take a look at the following resources: |
| 83 | + |
| 84 | +- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. |
| 85 | +- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. |
| 86 | + |
| 87 | +You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome! |
| 88 | + |
| 89 | +## Deploy on Vercel |
| 90 | + |
| 91 | +The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. |
| 92 | + |
| 93 | +Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details. |
0 commit comments