MyReads Project

This project was created for the Udacity Front End Web Development Course. The application displays a list of books that the user is currently reading, would like to read, and has read. It also gives the options to add books to their reading list.

To see the original project read me, view it here

How to install

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

How to Use

• Open web browser with address: localhost:3000

Files Included

• CONTRIBUTING.md
• README.md - This 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.
• public
  • favicon.ico # React Icon, You may change if you wish.
  • index.HTML
  • book-not-found.jpeg #Image for book covers not found.
• 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.
    • getAll
    • update
    • search
  • icons # Helpful images for your app. Use at your discretion.
    • add.svg
    • arrow-back.svg
    • arrow-drop-down.svg
  • 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.
  • BookList.js # Main book list area of app on the index package
  • BookShelf.js # Component for book shelf area
  • Search.js # Search page component for searching and retrieving books
  • ShelfChanger.js #Component for changing shelves. Can you use seperate from books in case you want to add more products later.
• Project-README.md #Original read me file for Udacity Project

Backend Server

To simplify your development process, we've provided a backend server for you to develop against.

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 repository contains starter code for all Udacity students. For details, check out CONTRIBUTING.md.

Project Contributors

Udacity Front End Web Development Nanodegree Program, 2018

Nikiya M. Simpson, Student

Resources

• Overview of MyReads A Book Tracking App given by Maeva (of France) from the EMEA Grow with Google Scholarship program

• Book not covered Image: http://i.imgur.com/J5LVHEL.jpg