This is a simple book management app written in React. User can search for books and add them to one of the three shelves below. User can also move the books from one shelf to another:
- Want to Read
- Currently Reading
- Read
To run the app:
- install all project dependencies with
npm install - start the development server with
npm start
This project is using a backend server created and maintained by Udacity. The API code lives in BooksAPI.js at BooksAPI.js which contains the methods to perform necessary operations on the backend:
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.
Method Signature:
update(book, shelf)- book:
<Object>containing at minimum anidattribute - 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
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.
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.
This repository is a simple React code. Therefore, we most likely will not accept pull requests.