GithubHelp home page GithubHelp logo

js-rails-as-api-design-documentation-exercise-a-atx01-seng-ft-060120's Introduction

API Design Exercise - A

Part I - Backend API Documentation

In this repository there is a Rails app. Your job is to explore that app (read and run the code) and write documentation for one of the resources. You should write your documentation in a markdown file.

Document the search action of the DogController. You should include information on:

  • how to access the resource
  • how to pass the search text
  • how to change the ordering

Once you've finished writing the documentation, send the markdown file to your partner.

Part II - Build a Frontend Feature

Your partner will send you a markdown file documenting an API. Using that documentation, add the following feature to your frontend app.

Build out the coffee search page in the coffee-frontend directory. It should

  • When the page loads, display a list of the first 5 coffees
  • When the user types an origin into the origin input, show the first 5 coffees whose origin matches
  • When displaying coffees, only show 5 results at a time
  • When the user clicks the 'Next' button, show the next 5 results

js-rails-as-api-design-documentation-exercise-a-atx01-seng-ft-060120's People

Contributors

aspenjames avatar dependabot[bot] avatar lizbur10 avatar maxwellbenton avatar rrcobb avatar

Watchers

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