Skip to content

Latest commit

 

History

History
66 lines (47 loc) · 2.13 KB

README.md

File metadata and controls

66 lines (47 loc) · 2.13 KB

Changelog Generator

The Changelog Generator is a web application that allows users to generate and view changelogs for GitHub repositories. Users can input a repository URL and a starting point (commit or date) to generate a changelog. The application fetches commit logs from the repository, summarizes them using a language model, and displays the summarized changelog to the user.

✨ Features

  • Generate Changelogs: Input a GitHub repository URL and starting point to create a changelog.
  • Summarize Commit Messages: Uses the Hugging Face Inference API to summarize commit logs for readability.
  • View Generated Changelogs: Access a list of previously generated changelogs via a user-friendly interface.
  • Persistent Storage: Changelogs are stored in a SQLite database for future reference.

🛠️ Technologies Used

  • Frontend: React, TypeScript, Tailwind CSS
  • Backend: Node.js, Next.js, SQLite
  • API Integration: Hugging Face Inference API for summarization

✅ Prerequisites

Before getting started, ensure you have the following installed:

  • Node.js: Version 14 or higher
  • npm: Version 6 or higher
  • A Hugging Face API Key

Step 1: Clone the repository

Run the following commands:

git clone https://github.com/ishanbhat2004/changelog-generator.git
cd changelog-generator

Step 2: Set up Hugging Face API Key

Sign up at Hugging Face and log in to your account.
Navigate to your account settings and generate an API key.
Create a .env file in the root of the project and add the following specifically:
HUGGINGFACE_API_KEY=your_huggingface_api_key

Step 3: Install Dependecies and Run the Project

Run npm install in the CLI
Run npm run dev in the CLI

The application is now running at http://localhost:3000/

💡 Usage

Generate Changelogs Navigate to the /developer endpoint. Input the repository URL and starting point (commit or date). The application fetches commits, summarizes them using Hugging Face API, and saves the changelog. View Changelogs Navigate to the /changelogs endpoint. View the list of previously generated changelogs.