Giter Club home page Giter Club logo

byob-frontend's Introduction

Tacos-Restaurants API Documentation

Visit App Here

Installation Instructions

  • In your terminal complete the following

    • clone down this repo run git clone https://github.com/mike-duke/byob-frontend.git
    • cd into the byob-frontend
    • npm install will install all dependencies required
    • npm start application will be live on the following port: localhost:3000
    • npm test will run test suite

    Background

    For this project we contributed to a public repo created by @JoelSmith @KylieStanley. They created a backend repo with a database storing top rated taco restaurants and the US citiies where they are located. After contributing to issues on the scrum board on thier repo page we pivoted to creating a front-end site where users could find documentation on how to consume their API.

    Project Details

    Using Jest and React.js we delivivered a fast single page appliction fueled by TDD. At the click of the button users are able to see a sample request body, status code for success, and reponse body for any given endpoint available on the server.

    Tech Stack

    • React
    • Jest
    • Enzyme
    • CSS
    • Heroku
    • TravisCI

    application

byob-frontend's People

Contributors

drhanciles avatar mike-duke avatar

Watchers

James Cloos avatar  avatar

Forkers

drhanciles

byob-frontend's Issues

Create Toggle City Components and Test File for Each Component

The following endpoints will toggle an expanded view of what is returned from the endpoint:

  • Get /api/v1/cities // gets all cities
  • Post /api/v1/cities // show example obj with keys required for successful post
  • Get /api/v1/cities/:id // gets cities by a specific id, show a sample request url and what can be returned
  • Put /api/v1/cities/:id // show example obj with keys required for successful put request
  • Delete /api/v1/cities/:id // show example url for delete and point and render what is returned

Create Toggle Restaurant Components Test File for Each Component

The following endpoints will toggle an expanded view of what is returned from the endpoint:

  • Get /api/v1/restaurants // gets all restaurants by rating ** via query params
  • Get /api/v1/restaurants/:id // gets a restaurant by a specific id, show an example request and then what would be returned
  • Get /api/v1/cities/:id/restaurants // gets all restaurants that are requested by a particular city id
  • Put /api/v1/restaurants/:id // show obj expected to receive for a successful put request
  • Post /api/v1/cities/:id/restaurants // show example object and request url path required to make successful post which allows you to add a new restaurant to the db
  • Delete /api/v1/restaurants/:id // show an example url path and show what is returned when this request is made successfully

Create Status Code Component

  • create a component that shows all status codes for all errors and success codes when making a request to the server.

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.