Skip to content

Latest commit

 

History

History
35 lines (30 loc) · 1.52 KB

README.md

File metadata and controls

35 lines (30 loc) · 1.52 KB

MOST STARRED REPOS DURING LAST MONTH

Description

webapp that will list the most starred Github repos that were created in the last 30 days.

project mockup

Features

  • As a User I should be able to list the most starred Github repos that were created in the last 30 days.
  • As a User I should see the results as a list. One repository per row.
  • As a User I should be able to see for each repo/row the following details :
    • Repository name
    • Repository description
    • Number of stars for the repo.
    • Number of issues for the repo.
    • Username and avatar of the owner.
  • As a User I should be able to keep scrolling and new results should appear (pagination).

USED TECHNOLOGIES

  • REACT JS
  • TYPESCRIPT
  • Eslint: for linting
  • Husky: to enforce linting code before committing it as well as enforce some guides while writing commit messages

this project created using npx create-react-app command

AVAILABLE SCRIPTS

npm start

to run the project in development mode hosted on https://localhost:3000 in your local machine

npm run build

to build the project for production

npm run lint

to check project to lint your project using eslint and check wether you broke the rules

npm run lint:fix

to fix linting problems