/github-dashboard

A web-based GitHub dashboard to show the most popular GitHub users, the most active GitHub users and their popular repositories.

Primary LanguageTypeScriptMIT LicenseMIT

GitHub Dashboard

Project   |    Technologies   |    Layout   |    User Stories   |    How To Use   |    License

GitHub language count GitHub top language GitHub repo size GitHub last commit Github license


๐Ÿ’ฌ Project

Develop a web-based GitHub dashboard to show the most popular GitHub users, the most active GitHub users and their popular repositories.

๐Ÿš€ Technologies

Projects developed with the main following technologies:

๐Ÿ”– Layout

You can view the layout of the project in the web version. You need to have a Figma account to access it.

๐Ÿ”– User Stories

  1. As a user I want to know the 3 most popular github users - the ones created in the last month and having the most followers;
  2. As a user I want to know the 3 most active users - the ones created last month and having the most repositories;
  3. As a user I want to see the name, image, id, total followers and the most starred project of each github user;
  4. As a user I want to be redirected to the user's github page when I click on "Open Profile"ยท I
  5. As a user I want to see the most starred repositories created last year, sorted by total stars;
  6. As a user I want to see the name, description and total stars of each repository.
  7. As a user I want to search users and repositories for a specific term

โ„น๏ธ How To Use

To clone and run this application, you'll need Git, Yarn and Node.js >= 14.16. From your command line:

# Clone the repository
$ git clone https://github.com/gisabernardess/github-dashboard.git

# Go into the repository
$ cd github-dashboard

# Install dependencies
$ yarn

# Run the development server
$ yarn dev

# Navigate to http://localhost:3000
# The app will automatically reload if you change any of the source files.

๐Ÿ“ License

This project is under the MIT license. See the LICENSE for more information.


Made with โ™ฅ by Gisele Silva ๐Ÿ‘‹ Get in touch!