MyReads React Course Final Project

This is my final assessment project for Udacity's React Fundamentals course. It has been made reactive using React.

Table of Contents

• Boot instructions
• Listing of the files
• Backend server explanation & methods
• Important remark regarding the search feature
• Create React App

Boot instructions

To get start the app:

• install all project dependencies with npm install
• install React Router with npm install react-router-dom
• start the development server with npm start

Listing of the files

├── CONTRIBUTING.md
├── README.md - This file.
├── SEARCH_TERMS.md # The whitelisted short collection of available search terms.
├── package.json # npm package manager file.
├── public
│   ├── favicon.ico # React Icon.
│   └── index.html # DO NOT MODIFY
└── src
    ├── App.css # The original styling of the app
    ├── App.js # This is the root of the app.
    ├── ListBooks.js # React Component rendering the list of all shelves (contains bookshelves)
    ├── BookShelf.js # React Component rendering a bookshelf (contains books)
    ├── Book.js # React Component rendering a book. (contains shelf selector)
    ├── ShelfSelector.js # React Component rendering the shelf selection option of books.
    ├── SearchPage.js # React Component rendering the search page.
    ├── App.test.js # Unused testing file
    ├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
    ├── icons # The icon images used for the app
    │   ├── add.svg
    │   ├── arrow-back.svg
    │   └── arrow-drop-down.svg
    ├── index.css # Global styles.
    └── index.js # Used for DOM rendering only.

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
• 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 remark regarding the search feature

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.