https://github.com/vetri02/myreads-react

Tracks books u read, add new books and their present reading status
https://github.com/vetri02/myreads-react

javascript jsx react udacity-nanodegree

Last synced: about 8 hours ago
JSON representation

Tracks books u read, add new books and their present reading status

• Host: GitHub
• URL: https://github.com/vetri02/myreads-react
• Owner: vetri02
• Created: 2017-07-25T20:05:48.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-08-06T16:21:37.000Z (over 7 years ago)
• Last Synced: 2024-11-09T09:48:32.876Z (about 2 months ago)
• Topics: javascript, jsx, react, udacity-nanodegree
• Language: JavaScript
• Homepage:
• Size: 26.4 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        

# React Fundamentals - MyReads project

## Setup

Run `npm install` and `npm start` to start the project from the root folder

## Backend Server

To simplify your development process, we've provided a backend server for you to develop against. The provided file [`BooksAPI.js`](src/BooksAPI.js) contains the methods you will need to perform necessary operations on the backend:

### `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(book, shelf)`

* book: `` containing at minimum an `id` attribute

* shelf: `` contains one of ["wantToRead", "currentlyReading", "read"]  

* Returns a Promise which resolves to a JSON object containing the response data of the POST request

### `search(query, maxResults)`p

* query: ``

* maxResults: `` Due to the nature of the backend server, search results are capped at 20, even if this is set higher.

* Returns a Promise which resolves to a JSON object containing a collection of 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](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.