An open API service indexing awesome lists of open source software.

https://github.com/scc416/github-timeline

This app accepts a GitHub username and produce a timeline containing name, created date and description of the user's repos.
https://github.com/scc416/github-timeline

axios axios-react css github-api github-timeline html javascript material-design-icons mdi moment moment-js momentjs react react-dom react-hooks react-redux reactjs redux redux-thunk timeline

Last synced: about 1 month ago
JSON representation

This app accepts a GitHub username and produce a timeline containing name, created date and description of the user's repos.

Awesome Lists containing this project

README

          

# GitHub Timeline

This app accepts a GitHub username and produce a timeline containing name, created date and description of the user's repos.

## Table of Content

- [Live Demo](#live-demo)
- [Final Product](#final-product)
- [Getting Started](#getting-started)
- [Dependencies](#dependencies)
- [Credit](#credit)

## Live demo

This project was deployed to [Netlify](https://www.netlify.com/):
https://the-github-timeline.netlify.app/

## Final Product

### Initial Layout

![Initial - Desktop](./docs/init-desktop.png)
![Initial - Phone](./docs/init-phone.png)

### Timeline

![Timeline - Desktop](./docs/timeline-desktop-1.png)
![Timeline - Desktop](./docs/timeline-desktop-2.png)
![Timeline - Phone](./docs/timeline-phone.png)

### Handle Error

![Error](./docs/error.png)

### Loading

![Loading](./docs/loading.png)

## Getting Started

1. Clone or download this repository onto your local device.
2. `cd` to the folder where this project is cloned.
3. Install all dependencies with `npm install` command.
4. Run the app in the development mode with `npm start` command.
5. Open the broswer and visit: [http://localhost:3000/](http://localhost:3000/).

## Dependencies

- [React](https://reactjs.org/)
- [Redux](https://redux.js.org)
- [Redux Thunk](https://github.com/reduxjs/redux-thunk)
- [React Redux](https://react-redux.js.org/)
- [Axios](https://axios-http.com/)
- [Moment.js](https://momentjs.com/)
- [Material Design Icons](https://materialdesignicons.com/): [@mdi/js](https://github.com/Templarian/MaterialDesign), [@mdi/react](https://github.com/Templarian/MaterialDesign-React)

## Credit

- [Design](https://www.behance.net/gallery/117986233/The-Timeline-Website) by [Polina Katasonova](https://www.behance.net/polypolya52336), [Pecode .](https://www.behance.net/pecodesoftware), [Yuliia Braslavska](https://www.behance.net/braslavska), [Myroslav Kroka](https://www.behance.net/myroslavkr5c50) & [Kris Andrushko](https://www.behance.net/Kris_Andrushko) on [Behance](https://www.behance.net/)
- [Favicons](https://www.flaticon.com/premium-icon/github_3488435) made by [IconsBox](https://www.flaticon.com/authors/iconsbox) from [www.flaticon.com](https://www.flaticon.com/).