neeraj-22 / github-timeline

Github timeline provides a better visualization of your repositories by organizing them in a timeline which is more readable to employers

Github Timeline

React based app to generate a vertical timeline of your repositories.

Link to the Project

Visualise your repositories in more organised way and use it to show your employers

Enter your username and get your profile visualised in a much better way

View all Repositories to get all of your repositories visualised as a timeline

Development

Prerequisite

1. Make sure you have Node.js version >= 13.

Install

Clone the repository into your system and open the directory and run this command to install all dependencies

npm install

PORT Config

To customise port of webapp, open package.json

1. Find Start under Scripts object
2. Assign the port value of your choice in set PORT
3. If you want default port(3000) then => "start" : "react-scripts start"

"scripts": {
    "start": "set PORT=8000 && react-scripts start"
  }

Start

npm start

github-timeline's Issues

Profile Page

Add top used languages in profile card and sort repositories according to the last commit date.

Make a route in which param repoPerPage can be given dynamically by user and make the HTML markup of timeline available to copy so it can be used in readme files.

Homepage Update

Improve the UI of overall webapp

All repositories timeline

Add lazy loading feature in all repositories page (as result is limited to 30 repos)