Description

This is an application that allows the user to search for books and save them in three different categories:

• Currently reading.
• Want to read.
• Read.

When you launch the app (npm install && npm start) you will see the bookstand with the three bookshelves. To move the book to another shelf or remove it from the bookstand, simply click on the arrow, a dropdown menu will show with all the options available.

If you want to add a book to any shelf, do this by clicking on the plus icon at the bottom right corner. That will show the search bar, type the book you are looking for and add the book desired by clicking on the arrow and selecting the shelf you want to add it to.

TL;DR

To get started developing right away:

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

Folder structure

├── CONTRIBUTING.md
├── README.md - This file.
├── package.json # npm package manager file
├── public
│   ├── favicon.ico # React Icon, You may change if you wish.
│   └── index.html # DO NOT MODIFY
└── src
    ├── App.css # Styles for your app. Feel free to customize this as you desire.
    ├── App.js # This is the root of your app. Contains static HTML right now.
    ├── App.test.js # Used for testing. Provided with Create React App. Testing is encouraged, but not required.
    ├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
    ├── icons # Helpful images for your app. Use at your discretion.
    │   ├── add.svg
    │   ├── arrow-back.svg
    │   └── arrow-drop-down.svg
    ├── pages # Holds the routes (pages) of the application
    │   ├── BookSearch.js # Each book item
    │   └── BookShelf.js # Each shelf, holds book items
    ├── index.css # Global styles. You probably won't need to change anything here.
    └── index.js # You should not need to modify this file. It is used for DOM rendering only.

Backend Server

To simplify the development process, the backend server was provided. The provided file BooksAPI.js contains the methods needed to perform necessary operations on the backend:

• getAll
• update
• search

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.

Contributing

This project does not accept pull requests.