The MyReads Book Tracking Project is my first of three Udacity React Developer Nanodegree projects. The project features two pages; a main page (library) and a search page. The library contains three bookshelves -Currently Reading, Want to Read, and Read- which display your books. The search page allows you to find and add new books to your library. Books can be moved to a different shelf from either page. Click the cover of a book to open a preview of that book. Enjoy filling your personal library!
To get started filling your library right away:
- install all project dependencies with
npm install
- start the development server with
npm start
├── README.md - This file.
├── 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.
├── Book.js # Presentational component that represents an individual 'book' within our project.
├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
├── Bookshelf.js # Presentaional component that represents a collection of books within our library.
├── 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.
├── Library.js # The project's main page which contains our three bookshelves.
└── Search.js # The project's search page where we add books to our library.
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.
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:
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.
Method Signature:
update(book, shelf)
- book:
<Object>
containing at minimum anid
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
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.
This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here.