MyReads App

About this project

This project is a implementation of myreads app that has allows a user to see books that they are currently reading, have read, and want to read. They have a way to move a book to either of the shelves.

They can also search for a book by author name or title and a view will show a book list matching their search. User can see which shelve a book belongs in the search view or move a book to a particular shelf.

Prerequisites

You need to have node js (>1.6)

Quick Overview

cd reactnd-project-myreads-starter/
npm install
npm start

Then open http://localhost:3000/ to see the app.

Installation

Install it once globally:

npm install -g create-react-app

Contents of this app

+--public/    
 |-- index.html - No need to modify
 |-- favicon.ico - React Icon
+-- src/
 +-- icons/ - Helpful images for my app.
  |-- add.svg
  |-- arrow-back.svg
  |-- arrow-drop-down.svg
 |-- App.js - This is the root of my app. Contains Routes, Books and Search components.
 |-- App.css - Styles for my app.
 |-- App.test.js - Used for testing. Provided with Create React App. 
 |-- Books.js - This component renders the list of books.
 |-- BooksAPI.js - A JavaScript API for the provided Udacity backend. 
 Instructions for the methods are below.
 |-- BookShelf.js - This component renders the dropdown for shelf selection.
 |-- index.js - You should not need to modify this file. It is used for DOM rendering only.
 |-- SearchBar.js - This component renders a component that has a search and Books.js component.
 |-- index.css - Global styles. You probably won't need to change anything here.
|-- .gitignore 
|-- CONTRIBUTING.MD - Information about contributing to this repo. 
TL;DR - Fork and clone your own version of this to use it.
|-- README.MD - This README file.
|-- SEARCH_TERMS.md - The whitelisted short collection of available search terms 
for you to use with your app.
|-- package.json - npm package manager file. It's unlikely that you'll need to modify this.

Backend Server

The provided file 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: <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(query, maxResults)

• query: <String>
• maxResults: <Integer> 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. 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.