https://github.com/aaronmoroney/myreads-2.0

JS-REACT
https://github.com/aaronmoroney/myreads-2.0

Last synced: 8 days ago
JSON representation

JS-REACT

• Host: GitHub
• URL: https://github.com/aaronmoroney/myreads-2.0
• Owner: AaronMoroney
• License: other
• Created: 2024-03-25T20:58:01.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-04-09T20:30:56.000Z (9 months ago)
• Last Synced: 2024-11-07T11:25:43.429Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 1.21 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Codeowners: CODEOWNERS

Awesome Lists containing this project

README

        
# MyReads

- This Project was completed As part of Udacity nano-degree in React.

## Prerequisites

Before you begin, ensure you have met the following requirements:

- You have installed the latest version of [Node.js](https://nodejs.org/)

- You have read [the latest documentation of React](https://reactjs.org/docs/getting-started.html).

## Installing MyReads

To install MyReads, follow these steps:

````bash

git clone https://github.com/yourusername/your-project-name.git

cd your-project-name

npm install

npm start

This will run the app in the development mode. Open http://localhost:3000 to view it in your browser.

````

## 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);

```