Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.94 KB

README.md

File metadata and controls

52 lines (30 loc) · 1.94 KB

GitHub Commit Viewer

The GitHub Commit Viewer is a web application designed to viewing and tracking commits within a specific GitHub repository. This app provides an intuitive and efficient way to explore commits and their associated details.

Table of Contents

KeyFeatures

  • Commit History: The heart of the app is the commit history viewer. Users can scroll through a chronological list of commits, including details like commit message, author, timestamp, and a link to the commit on GitHub.

  • Commit Details: Clicking on a commit provides a detailed view with the commit message, author's information, and a visual representation of the changes made, including additions and deletions in the codebase.

  • Search and Filtering: Powerful search and filtering options allow users to quickly narrow down commits based on keywords, authors, dates, and more. This makes it easy to find specific commits or track changes made by a particular contributor.

Installation

To run the GitHub Commit Viewer App locally on your machine, follow these steps:

Clone the repository to your local machine: git clone https://github.com/PerezCristian-dev/commit-viewer-client.git

Change into the project directory: cd commit-viewer-client

Install the required dependencies using npm: npm install

Usage

After installing the dependencies, you can use the following scripts to interact with the application:

Make sure you have the server running before initializing the project. You can clone the server using: git clone https://github.com/PerezCristian-dev/commit-viewer-server.git

and go to (https://github.com/PerezCristian-dev/commit-viewer-server.git) for details on how to run.

To run the application in development mode: npm run dev

To build the application for production: npm run build

To start the production server: npm run start