MyReads Project

Started with starter template and coded locally vs. in the work station. This app shows you a personal library of books that you are currently reading, want to read, and have read. You can search for other books and add them to your library. I used extra packages like bootstrap and styled components to help create a custom design and interactivity.

TL;DR

To get started developing right away:

• clone the project using git clone https://github.com/jedecast/reactnd-project-myreads-jan
• install all project dependencies with npm install
• start the development server with npm start

What's 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 # 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.
    ├── BookItem.js # This holds the individual book component that renders the thumbnail, title, author, and category selection.
    ├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
    ├── BooksGrid.js # Renders the entire list of books. Component is used in the main page and search page.
    ├── icons # Helpful images for your app. Use at your discretion.
    │   ├── add.svg
    │   ├── arrow-back.svg
    │   └── arrow-drop-down.svg
    ├── index.css # Didn't use index.css starter file. Instead, I used styled components to create a custom design fo the app
    ├── index.js # Added Brower Router to support url tracking
    ├── navMenu.js # Holds the "MyReads" logo and the "Add a Book" button that leads you to the search page
    └── searchBooks.js # Search page that includes the back button, the input field, and a grid that allows you to search for books

Extra Packages Downloaded

Downloaded react bootstrap (https://react-bootstrap.github.io/) and styled components (https://styled-components.com/) to help with custom styling.

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

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.