Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 2.16 KB

README.md

File metadata and controls

64 lines (40 loc) · 2.16 KB

MyReads Project

This application helps in managing your library by categorising the books in three categories - want to read, currently reading and already read.

You also have the ability to search for new titles and add them to your library.

Setup

To get started developing right away:

  • clone this repo git clone https://github.com/Manmohan7/reactnd-project-myreads-starter.git
  • install all project dependencies with npm install

Development Server

To run this application on your local run the command npm run start and navigate to http://localhost:3000/.

Any update in the source files will reload the application.

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.