CommitList Project

An app to review github commit history for a repo

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Infrastructure

About The Project

This web application utilizes the GitHub API to showcase information regarding commits within this repository. The application includes the capability to view the info of every commit by branch, it lets you see an interactive representation of all branches, and it's also possible to change the default repository to another one.

(back to top)

Built With

The tech stack used for this application is Typescript as the language, Node with NestJS framework as the backend and ReactJS for the frontend. The infrastructure is deployed to AWS and the provisioning of it is automated with terraform. The deployment is automated with the help of Github Actions to upload the Docker Image to the correspondent Elastic Container Registry.

• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

To run the project you need the following:

• node version greater or equal to v18.00

Installation

1. Clone the repo

   git clone https://github.com/rodrigofez/commitlist.git

2. Install NPM packages

   npm install

3. Run the project

   npm run dev

4. Once it's running you can access the frontend in http://localhost:5173/ and the backend in http://localhost:3000/api/v1

Build

npm install
npm run build
npm run start

Once it's running you can access the app in http://localhost:3000/ and the backend in http://localhost:3000/api/v1

(back to top)

Contributing

1. Fork the Project
2. Create your Feature Branch git checkout -b feat/new-feature
3. Commit your Changes git commit -m 'feat: add new feature'
4. Push to the Branch git push origin feat/new-feature
5. Open a Pull Request

(back to top)

Infrastructure

The application is deployed to AWS and provisioned with the help of terraform, some of the AWS services used are ECR, ECS with EC2, ALB and ASG.

(back to top)