MyReads - A Book Tracking App

Contents

• MyReads - A Book Tracking App
  • Contents
  • Introduction
  • Dependencies
    • Tutorials
    • Libraries
  • Using Locally
  • Contributing
• MyReads Project (Original Rubric)
  • TL;DR
  • What You're Getting
  • Backend Server
    • getAll
    • update
    • search
  • Important
  • Create React App
  • Contributing

Introduction

The goal for this project was to take existing React.js code and add functionality to it. See the original project rubric for specifics.

Dependencies

Tutorials

First and foremost, I have to give a gargantuan "thank you" to the instructors who published videos to help the students. I would truly, truly be lost were it not for their instruction.

• Maeva
• Forrest
• Ryan

Libraries

I didn't use too many resources outside of some of the typical tools that go with a React.js project.

• ESLint & Prettier
• react-dom
• react-router-dom
• react-scripts

Using Locally

To fire it up on your own machine, fork or clone your own copy.

1. From the project root, open a terminal and run npm install to install all package dependencies
2. Once all dependencies are installed, run npm start to start up a local server instance
3. Move the books from shelf to shelf, or search and add new ones

Contributing

If you've read this far then you know this was an assigned project, and as such will not be open to pull requests or contributions. I imagine someone smarter than me could write it better, anyway!

MyReads Project (Original Rubric)

This is the starter template for the final assessment project for Udacity's React Fundamentals course. The goal of this template is to save you time by providing a static example of the CSS and HTML markup that may be used, but without any of the React code that is needed to complete the project. If you choose to start with this template, your job will be to add interactivity to the app by refactoring the static code in this template.

Of course, you are free to start this project from scratch if you wish! Just be sure to use Create React App to bootstrap the project.

TL;DR

To get started developing right away:

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

What You're Getting

├── 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.
    ├── 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
    ├── 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.

Remember that good React design practice is to create new JS files for each component and use import/require statements to include them where they are needed.

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.

Contributing

This repository is the starter code for all Udacity students. Therefore, we most likely will not accept pull requests.

For details, check out CONTRIBUTING.md.