/my-reads-app

This my-reads-app is a React project that is a part of the Udacity React Nanodegree program.

Primary LanguageJavaScript

my-reads-app: A Udacity React Nanodegree Project

Welcome. This project was bootstrapped with Create React App.

Usage

This project is being used as the final assessment project for the React Fundamentals portion of Udacity's React Nano Degree program. This project will be evaluated by a grader at Udacity.

App Preview - while not pretty, that was not the goal of this

My Reads Image

Setup

npm install

Installs any project dependencies that are needed to run the app.

npm start

Runs the app in development mode.
Open http://localhost:3000 to view it in the browser.

Backend Server

To simplify your development process, we've provided a backend server for you to develop against. The provided file BooksAPI.js contains the methods you will need to perform necessary operations on the backend:

getAll

Method Signature:

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

Method Signature:

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

Method Signature:

search(query)
  • query: <String>
  • Returns a Promise which resolves to a JSON object containing a collection of a maximum of 20 book objects.
  • These books do not know which shelf they are on. They are raw results only. You'll need to make sure that books have the correct state while on the search page.

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, so don't be surprised if your searches for Basket Weaving or Bubble Wrap don't come back with any results.

Contact

Please feel free to contact me at tworkman512@gmail.com or Slack me @tom.workman