GitHub Release Stats

A modern, responsive website for analyzing GitHub release statistics. Search for users or organizations, view their repositories, and get detailed insights into release patterns, download statistics, and asset performance.

🚀 Getting Started

Prerequisites

• Node.js 18+
• npm, yarn, or pnpm

Installation

1. Clone the repository

   git clone https://github.com/RLAlpha49/Github-Release-Stats.git
   cd github-release-stats

2. Install dependencies

   npm install
   # or
   yarn install
   # or
   pnpm install

3. Start the development server

   npm run dev
   # or
   yarn dev
   # or
   pnpm dev

4. Open your browser

   Navigate to http://localhost:3000 to see the application.

Environment Variables

For higher rate limits, you can optionally set up a GitHub Personal Access Token:

# .env.local
GITHUB_TOKEN=your_personal_access_token_here

🛠️ Development

Available Scripts

# Development
npm run dev          # Start development server
npm run build        # Build for production
npm run start        # Start production server

# Code Quality
npm run lint         # Run ESLint
npm run format       # Format code with Prettier
npm run format:check # Check if code is formatted correctly

# Dependencies
npm run update-deps  # Update dependencies (excludes Tailwind CSS)

Code Formatting

This project uses Prettier for code formatting and ESLint for linting.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.