Giter VIP home page Giter VIP logo

github-explorer's Introduction

logo

Github Explorer 0.1.0

This sample project helps to explore open GitHub repositories. Where the user can get the required public repository information, such as the repository name, the number of stars and forks, the updated date, the total number of issues, and the default branches. Additionally, you can use pagination to select the number of items per page and organize the list of the searched repositories according to various criteria.

Used API: https://api.github.com/

Features

The application has two pages, a Home page, and a Detail Page

👉 On the Home Page users can

  • Search public repositories
  • Filter searched repositories options
  • Have pagination.
  • Change number of data per page options
  • Get the searched repositories containing detail like Owner Name, Repository Name, Total stars, Total forks, Watched count, last updated date, and short description.

👉 On the Detail Page users can

  • View selected repository detail like Owner Name, Repository Name, Avatar, Total Issue, and Default Branch.
  • The user will be direct to the owner's GitHub page if clicked on the owner name or repository name.

Used Stack

🔥 React : "^18.2.0"

🔥 TypeScript : "^4.7.4"

🔥 Redux toolkit : "^8.0.2"

🔥 Tailwind : "^3.1.8"

Used Packages / Dependencies

🐒 axios : "^0.27.2"

🐒 react-paginate : "^8.1.3"

🐒 react-router-dom : "^18.0.6"

🐒 nanoid : "^4.0.0"

Installation

Clone the repo

# Clone the repo
https://github.com/NishChal370/Github-explorer.git

Install the app

# Install dependencies
npm install

# Build the project
npm run build

# Run the app
npm start

Filter Options

Repository_Sort

💠 Best match 💠 Most starts 💠 Fewest stars 💠 Most forks 💠 Fewest forks 💠 Recently updated 💠 Last updated

Per_Page_Option

🔺 10 per page 🔺 25 per page 🔺 50 per page

Package uses

axios : It is used to send asynchronous HTTP requests to REST endpoints. This library is very useful to perform CRUD operations. This popular library is used to communicate with the backend. Axios supports the Promise API, native to JS ES6.

react-router-dom : React Router is used to define multiple routes in the application. When a user types a specific URL into the browser, and if this URL path matches any 'route' inside the router file, the user will be redirected to that particular route.

react-paginate : It is used to allow users can easily switch between pages across a website or app. With the help of this component, a user can select a specific page from a range of pages.

nanoid : A tiny, secure, URL-friendly, unique string ID generator for JavaScript.


To learn React, check out the React documentation.

github-explorer's People

Contributors

nishchal370 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.