Skip to content

sc2646/reactnd-project-myreads-starter

 
 

Repository files navigation

MyReads Project

This is MyReads project for Udacity’s React Nanodegree. You can select and categorize books in different bookshelves, including read, currently reading, and want to read. This project is built with React and an API is provided to get the data from backend server.

Quick Start

To run locally:

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

Demo

Change bookshelves in main page Search term and results

Backend Server

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.

Contributing

This repository is the starter code for all Udacity students. Therefore, we most likely will not accept pull requests.

For details, check out CONTRIBUTING.md.

About

Starter Code for the React MyReads Project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 72.2%
  • CSS 19.9%
  • HTML 7.9%