This is a My Reads Bookshelf that allows you to categorizes books into what you currently reading, want to read, and read already. You can reorganize the books to any shelf that you want and look through the library search function to add more books to your bookshelf.
To get start the application:
- install all project dependencies with
npm install
- start the server with
npm start
├── CONTRIBUTING.md
├── README.md - This file.
├── SEARCH_TERMS.md
├── package.json
├── public
│ ├── favicon.ico
│ └── index.html
└── src
├── App.css
├── App.js # This is the root of your app.
├── Book.js
├── BookChanger.js
├── Bookshelf.js
├── Search.js
├── SearchBar.js
├── Shelf.js
├── BooksAPI.js # A JavaScript API. Instructions for the methods are below.
├── icons
│ ├── add.svg
│ ├── arrow-back.svg
│ └── arrow-drop-down.svg
├── index.css
└── index.js
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.