MyReads is a bookshelf app that allows you to search, select and categorize books you have read, are currently reading, or want to read.
To get started developing right away:
- install all project dependencies with
npm install - start the development server with
npm start
├── 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
├── components # React components.
│ ├── BookShelf
│ ├── BookShelf.js # Renders a book shelf
│ ├── index.js # Exports component
│ ├── BookShelfItem
│ ├── BookShelfItem.js # Renders a book
│ ├── index.js # Exports component
│ ├── BookList
│ ├── BookList.js # Renders the book shelves
│ ├── index.js # Exports component
│ ├── Search
│ ├── Search.js # Renders the search page
│ ├── index.js # Exports component
│ ├── SearchBar
│ ├── SearchBar.js # Renders the search bar
│ ├── index.js # Exports component
│ ├── SearchButton
│ ├── SearchButton.js # Renders the search button
│ ├── index.js # Exports component
│ ├── SearchResults
│ ├── SearchButton.js # Renders the search results
│ ├── index.js # Exports component
│ └── arrow-drop-down.svg
├── icons # Helpful images for your app. Use at your discretion.
│ ├── add.svg
│ ├── arrow-back.svg
│ └── arrow-drop-down.svg
├── 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.
├── 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.
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 anidattribute - 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, maxResults)- query:
<String> - maxResults:
<Integer>Due to the nature of the backend server, search results are capped at 20, even if this is set higher. - Returns a Promise which resolves to a JSON object containing a collection of 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.
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.
This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here.