https://github.com/olavoparno/git-commits

Display and surf through Git Commits
https://github.com/olavoparno/git-commits

Last synced: 2 days ago
JSON representation

Display and surf through Git Commits

• Host: GitHub
• URL: https://github.com/olavoparno/git-commits
• Owner: olavoparno
• Created: 2019-05-18T22:09:05.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-01-07T05:35:30.000Z (about 2 years ago)
• Last Synced: 2025-01-03T01:18:05.597Z (6 days ago)
• Language: TypeScript
• Homepage: https://git-commits.vercel.app/
• Size: 4.27 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        
# Git Commits

[![Interfaced with React](https://d2eip9sf3oo6c2.cloudfront.net/tags/images/000/000/026/square_128/react.png "Interfaced with React")](https://reactjs.org/)

[![Written in TypeScript](http://www.typescriptlang.org/assets/images/icons/nuget-icon-128x128.png "Written in TypeScript")](http://www.typescriptlang.org)

[![Tested with Jest](https://d2eip9sf3oo6c2.cloudfront.net/tags/images/000/000/940/square_128/jestlogo.png "Tested with Jest")](https://jestjs.io/)

[![Documentation built by TypeDoc](https://typedoc.org/images/logo-128.png "Documentation built by TypeDoc")](https://typedoc.org)

| Statements | Branches | Functions | Lines | Build Status | Built By | We Love |

| -----------|----------|-----------|-------| ------------ | -------- | ------- |

| ![Statements](https://img.shields.io/badge/Coverage-11.32%25-red.svg) | ![Branches](https://img.shields.io/badge/Coverage-4.08%25-red.svg) | ![Functions](https://img.shields.io/badge/Coverage-10.64%25-red.svg) | ![Lines](https://img.shields.io/badge/Coverage-11.43%25-red.svg) | ![BuildStatus](https://img.shields.io/badge/Build-Passing-brightgreen.svg "Building Status") | ![BuiltBy](https://img.shields.io/badge/TypeScript-Lovers-black.svg "img.shields.io") | ![ForTheBadge](https://img.shields.io/badge/Using-Badges-red.svg "ForTheBadge")

## Motivation

* A test for a Front-End job application and a sheer desire to learn more and more everyday

## Online Demo

* Click here to preview -> [Git Commits Surfer](https://infallible-tesla-d939f4.netlify.com/)

### Setup Development Environment

1. Clone the project from https://github.com/olavoparno/git-commits.git

2. Run `npm install` in order to install the project dependencies

3. Run either `npm run build` to literally build the project into `/build` or run `npm start` in order to serve the project in your browser

### External Libs used

1. [React Table](https://github.com/tannerlinsley/react-table)

   - Chosen due to its implementation simplicity

2. [React Select](https://github.com/JedWatson/react-select)

   - Same as React Table

3. [React Debounce Input](https://github.com/nkbt/react-debounce-input)

   - Also chosen due to its ease of use using debounce while already implementing key press events

4. [Typedoc](https://github.com/TypeStrong/typedoc)

   - Used to document the whole project with its JSDoc markups

5. [Changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli)

   - Adopted in order to keep track of releases and its changes

6. [Jest Badges Readme](https://github.com/olavoparno/jest-badges-readme)

   - Locally track test coverage ratios with readme badges

  

### TODO

* A better state management implementation

* React components unit tests

* TypeDoc declarations throughout the project

* Better componentization definition

* Decentralization of styles either with continued SCSS usage or with styled-components

* Add display functionalities when clicking the commit

* Implement unit tests for React Components and Github service