/reactnd-project-myreads

Code for the myreads project of the Udacity ReactND program

Primary LanguageJavaScript

Install

Best used by installing yarn, available as an npm package. Simply clone the projcet, install npm and yarn, and hit yarn start The localhost will come up on port 3006, but is configurable.

Backend Server

The provided file BooksAPI.js contains the methods one will need to perform necessary operations on the backend:

getAll()

  • Returns a Promise which resolves to a JSON object containing a collection of book objects.
  • This collection represents the books currently in the bookshelves in your app.

update(book, shelf)

  • book: <Object> containing at minimum an id attribute
  • shelf: <String> contains one of ["wantToRead", "currentlyReading", "read"]
  • Returns a Promise which resolves to a JSON object containing the response data of the POST request

search(query, maxResults)

  • query: <String>
  • maxResults: <Integer> Due to the nature of the backend server, search results are capped at 20, even if this is set higher.
  • Returns a Promise which resolves to a JSON object containing a collection of book objects.

Important

The backend API uses a fixed set of cached search results and is limited to a particular set of search terms, which can be found in SEARCH_TERMS.md. That list of terms are the only terms that will work with the backend.

create-react-app

This project was bootstrapped with Create React App.