Skip to content

chaimabg/GitHub-Repositories

Repository files navigation

React Application

Purpose

Creating a responsive interface of a GitHub profile that follows good UX principles, using React Typescript, Material UI and the official GitHub API to fetch repositories per user.
This interface allows the user to filter through the repositories by name, consult the GitHub profile and open a repository.
You can check the deployed application here.

Future Improvements

  • Adding a pagination for repositories
  • Improving the design
  • Adding a filter for GitHub profiles by username
  • Using the v4 API

Interface

interface

Requirements

Build project

$ git clone https://github.com/chaimabg/GitHub-Repositories.git
$ cd GitHub-Repositories
$ npm install

Before running the project you need to create a .env file in the project directory that contains this environment variables:

REACT_APP_GITHUB_TOKEN='your github token'
REACT_APP_GITHUB_USERNAME='any github username'

Available Scripts

In the project directory, you can run:

npm start

Runs the app in the development mode.
Open http://localhost:3000 to view it in the browser.

The page will reload if you make edits.
You will also see any lint errors in the console.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages