Giter Club home page Giter Club logo

metapi's Introduction

Meta-API

Contributors

Deployed Site

metAPI

Learning Goals:

  • Get comfortable with TypeScript
  • Continue gaining familiarity with React / Cypress / Router
  • Create an app that we all feel comfortable and confident with to show on our portfolio's

Wins:

  • Gained comfortability with TypeScript
  • Gained confidence with React / Cypress / Router
  • Worked with API data that was structured in a way we weren't so familiar with before hand
  • Kept up with sprint deadlines and never felt pressed for time

Challenges:

  • Utilizing TypeScript with React and the problems that come with a framework in Typescript

Overview of Site:

Meta-Api is a web app that allows a user to:
  • Browse public Apis' in a gallery of Api cards
  • Favorite an Api from the gallery view to add it to your saved Apis(Using local storage)
  • View favorited Apis in the Sidebar's Saved Apis section
  • See more details of an Api by clicking on that Api's card card
  • Once on the details page, a user can write their own notes for that Api that will also be saved through local storage, that they can check back on and delete if neccessary

Screenshots / Screen Recordings

Gallery Homepage:

metAPI gif

Featured Api page:

detailspage

Sidebar Open:

homepage

Technologies Used:

  • React
  • ReactRouter
  • JavaScript
  • HTML5
  • Webpack
  • Cypress
  • Node
  • TypeScript

Setup

  • To access the site on your local machine:
    • Clone down the repo through the command line
    • Run $npm install to install dependencies
    • Run $npm start to open the page on a local browser
  • Otherwise the site is deployed and accessible here

Running Tests

  • After completing the setup steps above:
    • Run $npx cypress open to open up the test suite
    • From there click on the metAPI-testing file to open it in your browser and watch the tests run automatically

metapi's People

Contributors

jacksonmcguire avatar itsnameissteven avatar cbmackintosh avatar

Forkers

sarahlane8

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.