Git Product home page Git Product logo

grepos's Introduction

Github Repo Fetcher

The Github Repo fetcher is a simple web app that takes a Github username or organization as an input and gets that user's public repositories and displays them in a tabular format.

The repositories can be sorted by Name, Created At, Updated At and Pushed At.

Progress Notes

The following items will be included in an upcoming sprint.

-- pagination
-- unit tests
-- UI fit and finish

Project Structure

grepos/
├── README.md
├── package.json
├── src/
│   ├── index.js
│   ├── App.js
│   ├── models/
│   │   ├── repos.models.ts
│   ├── components/
│   │   ├── repos/
│   │   ├── repo-table/
│   │   ├── button/
│   │   ├── form-input/
│   │   ├── header/
│   ├── services/
│   │   └── repos.service.ts
│   ├── store/
│   │   ├── repos/
│   │   |   ├── repos-reducer.ts
│   │   |   ├── repos-saga.ts
│   │   |   ├── repos-selector.ts
│   │   |   ├── repos-types.ts
│   │   ├── root-reducer.ts
│   │   ├── root-saga.ts
│   │   ├── root-saga.ts
│   |   ├── store.ts

Notable Technical Decisions

React Component Type, Class vs Functional

Based on the current requirements of the application, React Functional components are used exclusively. Currently, there is no need to leverage the life cycle hooks made available with React Class components.

State Management, React Context vs any flavor of Redux

The requirements of the this application could have easily been achieved using simply React Context, but I decided on a Redux library to demonstate how a more complicated application might be architected.

Data Api Abstraction

The data API is request and response handling is abstracted in a service. The client does not need to have knowlege about the schema of the raw data or details regarding the response handling. The client simply has an agreed upon contract with the service. The encapsulates the logic and responsibility of interacting with the Github API service and transforming the response data in the repos api service.

The schema of the response to the client is a simple example of a data driven UI. The response is instructing what layout type to use to display the data.

Running the app

In the project root directory, entering the following commands in the terminal

install dependencies by running npm install or yarn

start the application by running npm start or yarn start

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

run tests with npm test or yarn test

Launches the test runner in the interactive watch mode.

Future improvements

--- pagenation for the repositories
--- unit tests
--- improve typing
--- UI fit and finish
--- responsive / adaptive UI ???
--- Make the Table component more generic
--- Error handling
--- Form validation
--- Security
--- Internationalization
--- Accessibility
--- Client side caching
--- Loading state handling
--- Navigate to Repo Detail Page
--- Get Repos Issues from
--- Card based layout option

grepos's People

Contributors

gigmania 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.