Skip to content

README.md

Latest commit

 

History

History
119 lines (86 loc) · 2.75 KB

README.md

File metadata and controls

119 lines (86 loc) · 2.75 KB
Raw

HotGits is a sleek, full-stack web app that surfaces GitHub's most-starred repositories across multiple time ranges. It features a dark glassmorphism UI with modern animations, backed by an Express + MongoDB API with automatic caching.

🛠️ Tech Stack

  • Frontend — Vanilla HTML / CSS / JavaScript (no framework needed)
  • Backend — Node.js · Express · Mongoose
  • Database — MongoDB (with 30-day TTL cache)
  • API — GitHub Search API

🚀 Getting Started

Prerequisites

  • Node.js v18+
  • MongoDB running locally or a cloud URI (e.g. MongoDB Atlas)

Installation

# 1. Clone the repository
git clone https://github.com/<your-username>/hotgits.git
cd hotgits

# 2. Install dependencies
npm install

# 3. Create a .env file in the project root
#    Add your MongoDB connection string:
echo "MONGO_URI=mongodb://localhost:27017/hotgits" > .env

Running

# Development (with auto-reload)
npm run dev

# Production
npm start

Then open http://localhost:5000 in your browser.

📁 Project Structure

hotgits/
├── backend/
│   ├── config/
│   │   └── db.js              # MongoDB connection
│   ├── controllers/
│   │   └── trendingController.js  # GitHub fetch & cache logic
│   ├── models/
│   │   └── Trending.js        # Mongoose schema (TTL index)
│   ├── routes/
│   │   └── trending.js        # /api/trending route
│   └── index.js               # Express server entry point
├── frontend/
│   ├── index.html             # Main page
│   ├── style.css              # Glassmorphism theme & animations
│   └── app.js                 # Client-side fetch & render
├── .env                       # Environment variables
├── package.json
└── README.md

🔌 API Reference

GET /api/trending

Fetch trending GitHub repositories.

Parameter Type Default Description
duration string week Time range: day, week, month, year

Example:

curl http://localhost:5000/api/trending?duration=month

Response:

{
  "duration": "month",
  "repos": [
    {
      "id": 123456,
      "name": "owner/repo-name",
      "owner": "owner",
      "description": "A cool project",
      "url": "https://github.com/owner/repo-name",
      "stars": 12500,
      "forks": 890,
      "language": "TypeScript",
      "avatar": "https://avatars.githubusercontent.com/u/..."
    }
  ]
}

Inspired by https://roadmap.sh/projects/github-trending-cli