https://github.com/rawdaymohamed/myreads
https://github.com/rawdaymohamed/myreads
javascript nodejs react react-router reactjs udacity udacity-nanodegree
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/rawdaymohamed/myreads
- Owner: rawdaymohamed
- Created: 2021-12-13T16:54:49.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-12-19T14:16:58.000Z (over 1 year ago)
- Last Synced: 2025-10-08T09:44:55.656Z (9 months ago)
- Topics: javascript, nodejs, react, react-router, reactjs, udacity, udacity-nanodegree
- Language: JavaScript
- Homepage: https://6764190014cee31ea1de4a95--myreads-rawdaymohamed.netlify.app/
- Size: 4.55 MB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# MyReads
MyReads is a front end Web app built in React js. It allows users to categorize books into 3 categories, called shelves (currently reading, want to read, and read).
The application interacts with an [api]("https://reactnd-books-api.udacity.com") to get books names, authors, and images.
## YouTube Demo
[Project Link](https://www.youtube.com/watch?v=oZ87UINeqbA)
## **Node version**
Please make sure you are using node.js version: **`v10.24.1`**
## TL;DR
To get started developing right away:
- install all project dependencies with `npm install`
- start the development server with `npm start`
## 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.