This is the project, that you move yours books in your set shelf. You have three shelfs: Currently reading, whant to reading and read and add others books that are not on the shelf.
To get started developing right away:
- install all project dependencies with
npm install - start the development server with
npm start - run tests
npm test - code coverage report
npm run coverage
├── 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
├── api
└── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
├── components
├── books
├── AddBooksShelf.js # A component react that list books that are not on the shelf and filters by book title
├── ListBooks.js # A component react that shows a list of books and titles the listing
└── TabBooks.js # A component react that list all books of the shelf
└── App.js # This is the root of your app. Contains static HTML right now.
├── style
└── App.css # Styles for your app. Feel free to customize this as you desire.
├── test
├── AddBooksShelf.test.js # Used for testing component.
├── App.test.js # Used for testing component.
├── ListBooks.test.js # Used for testing component.
└── TabBooks.test.js # Used for testing component.
├── 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.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.