Skip to content

MyReads Project implements a virtual book library using React

Notifications You must be signed in to change notification settings

IRNiti/myreads

 
 

Repository files navigation

MyReads Project

Description

This is the completed project for Udacity's React Fundamentals course. The functionality allows you to display books in 3 shelves (Want To Read, Currently Reading, Read) and to update shelves for each book. The app also has a search functionality that allows you to add new books to one of the three shelves (note that not all search terms will work as is explained further on). For books with missing information like authors or thumbnails, they will be displayed without those details.

To get started:

  • install all project dependencies with npm install
  • start the development server with npm start

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.

Create React App

This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here.

About

MyReads Project implements a virtual book library using React

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 69.7%
  • CSS 21.7%
  • HTML 8.6%