Git Product home page Git Product logo

cy-ai-take-home's Introduction

CyHub - Repository Manager

A Simple React App that allows the user to view the most popular repositories, and manage their own repositories.

Features

  1. Overview Tab - Displays the most popular repositories
  2. Repository Tab - Displays repositories in order of most recently updated
  • Users are also able to filter through the results in the repository tab through the input field
  1. Unit Tests - Simple Tests to verify Code is running correctly
  2. Profile Section - Displays a default profile avatar and the user name of profile currently in view

Authors

Justen Quirante

Setup Instructions

  1. Fork this repo
  2. Clone your forked copy of this repo
    • git clone https://github.com/jquirante/cy-ai-take-home.git
  3. Change directory into the newly cloned repo
    • cd
  4. Install dependencies
    • npm install
  5. Start dev server
    • npm start
  6. Open a browser and navigate to localhost:3000

To Run Tests, use "npm test" in terminal/command prompt. Press a and enter to rerun all test files.

Libraries/Tools Used

React

Main Front End Library to create the interface of the web application. I used it for the ease of use and performance

CSS

Main language used for styling application components

JavaScript

Used to add functionality to React Components. Javascript and React go hand in hand

Create React App

Boiler Plate code from Facebook to quickly configure the React application

Materialize CSS

Used for quick styling improvements for the following:

  1. Font
  1. Navigation Menu
  2. Grid/Layout

Axios

Library to assist with AJAX requests to the GitHub Open API

React-Router-DOM

Enhances React functionality by routing users to a specific url and rendering a specific component based on that url path or route

Ex: The Overview Component (Component that contains the list of repos) in the "Overview Tab" is rendered for the base url "/" while the Repositories Component (Similar component for rendering repos) in the "Repositories Tab" are rendered for a url that matches "/repositories"

Enzyme

React-testing Library. Assists with rendering components and accessing component members while testing

Jest

Runs our Unit Tests as React's default testing library

cy-ai-take-home's People

Contributors

jquirante avatar

Watchers

James Cloos avatar  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.