nomadnic / MyReads

Udacity MyReads project

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

MyReads Project

This is my implemnetation of the MyReads project as part of the Udacity React Nanodegree Program.

MyReads is a book tracking web application that allows you to search for and categorize books by Currently Reading, Want to Read, and Read.

Installation

To get started developing right away:

  • 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 book search API uses 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.

About

Udacity MyReads project


Languages

Language:JavaScript 67.1%Language:CSS 24.1%Language:HTML 8.9%