Skip to content

Web application built using React.js in order to display a fraction of data from the github API.

License

Notifications You must be signed in to change notification settings

penedon/hubview

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HubView

Author: Gustavo F Penedo

1. Getting Started

Instructions to access the solution.

1.1. Local

In the project directory, you can run:

npm start

Runs the app in the development mode.\

Open http://localhost:3000 to view it in your browser.

1.2. Cloud

Check: https://hubview-ui-prd.herokuapp.com/

2. Description

This repository demonstrates my knowledge in build web applications using modern approachs. Below are the items that were included in this exercise.

Goal: Develop an application, that is enable to view github 
      profiles, it's repositories, branches and commits by
      providing a search interface, in less than 5 days

Solution Requirements:

  • JS Frontend Framework
    • Using React 18
  • GitHub repository with clear documentation on how to run it
  • Search/List all public repositories of a github user.
  • Given a repository, list all branches
  • Given a branch, list all it's commits

Solution Desirable Features:

  • Componentization
  • Code Structure
  • Error Treatment
  • Responsive
    • Using Bootstrap and media queries to improve responsiveness
  • Application Flux
      1. Search User
      1. Select a Repository
      1. Select a Branch
  • OPTIONAL: Heroku Deploy
    • Informed at section 1.2

3. Routes

  • / - Redirects to /search
  • /search - Main Search Page
  • /profile/:user - User Profile
  • /profile/:user/:repository/ - User Repository

Notes

Any questions, please feel free to ask me through the contact information at the bottom of this file.


Contact

About

Web application built using React.js in order to display a fraction of data from the github API.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published