https://github.com/maryehb/udacity-myreads-react-web-app
https://github.com/maryehb/udacity-myreads-react-web-app
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/maryehb/udacity-myreads-react-web-app
- Owner: MaryEhb
- Created: 2021-08-12T10:38:08.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2021-08-12T10:40:56.000Z (almost 5 years ago)
- Last Synced: 2025-02-28T08:00:17.110Z (over 1 year ago)
- Language: JavaScript
- Size: 322 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# MyReads Project For Udacity Nanodegree
This is a single page web application that allow the user to search in udacity database for different books and place it on her/his shelves (currently reading - read - want to read)
## Requirements
- Node.js on the user's device
## How to Run The Appication
In the command line: browse to the folder and run `npm install`.Once it is installed run `npm start` and the application will open in the default browser on local host 3000
## Backend Server
To simplify your development process, we've provided a backend server for you to develop against. The provided file [`BooksAPI.js`](src/BooksAPI.js) contains the methods you will need to perform necessary operations on the backend:
* [`getAll`](#getall)
* [`update`](#update)
* [`search`](#search)
### `getAll`
Method Signature:
```js
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:
```js
update(book, shelf)
```
* book: `` containing at minimum an `id` attribute
* shelf: `` 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:
```js
search(query)
```
* query: ``
* 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](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.