Skip to content
This repository has been archived by the owner on Jun 28, 2022. It is now read-only.

Completed MyRead App Project #108

Open
wants to merge 11 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
node_modules
.DS_Store

94 changes: 24 additions & 70 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,92 +1,46 @@
# MyReads Project

This is the starter template for the final assessment project for Udacity's React Fundamentals course. The goal of this template is to save you time by providing a static example of the CSS and HTML markup that may be used, but without any of the React code that is needed to complete the project. If you choose to start with this template, your job will be to add interactivity to the app by refactoring the static code in this template.

Of course, you are free to start this project from scratch if you wish! Just be sure to use [Create React App](https://github.com/facebookincubator/create-react-app) to bootstrap the project.

## TL;DR

To get started developing right away:

* install all project dependencies with `npm install`
* start the development server with `npm start`

## What You're Getting
```bash
├── 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
├── App.css # Styles for your app. Feel free to customize this as you desire.
├── App.js # This is the root of your app. Contains static HTML right now.
├── App.test.js # Used for testing. Provided with Create React App. Testing is encouraged, but not required.
├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
├── 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.
```

Remember that good React design practice is to create new JS files for each component and use import/require statements to include them where they are needed.
This repository contains my implementation of the MyReads app. This is the final assessment project for the Udacity's React Fundamentals course, part of the React Nanodegree Program. MyReads is a bookshelf app that allows the user to select and categorize books they have read, are currently reading, or want to read.

## Backend Server
## Demo

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:
## Getting Started

* [`getAll`](#getall)
* [`update`](#update)
* [`search`](#search)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### `getAll`
Prerequisites
The project can be built with npm or yarn, so choose one of the approach bellow in case you don't have any installed on your system.

Method Signature:
* npm is distributed with Node.js which means that when you download Node.js, you automatically get npm installed on your computer. Download Node.js.

```js
getAll()
```
or

* 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.
* Yarn is a package manager built by Facebook Team and seems to be faster than npm in general. Download Yarn

### `update`
## Installing

Method Signature:
To download the project follow the instructions bellow

```js
update(book, shelf)
```git clone https://github.com/sarahalawfi/reactnd-project-myreads-starter.git
npm install
```
Once all of the dependencies have been installed you can launch the app with

* book: `<Object>` containing at minimum an `id` 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

### `search`

Method Signature:

```js
search(query)
```
npm start
```
A new browser window should automatically open displaying the app. If it doesn't, navigate to http://localhost:3000/ in your browser

* 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.
![alt text](src/img/homepage.png)

## 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.
## How to Use the App

## Create React App
* Books are sorted into three categories: Currently Reading, Want to Read and Read

This project was bootstrapped with [Create React App](https://github.com/facebookincubator/create-react-app). You can find more information on how to perform common tasks [here](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md).
* To change a book's category or remove a book from the list, click on the green button on the book cover
![alt text](src/img/one.png)

## Contributing

This repository is the starter code for _all_ Udacity students. Therefore, we most likely will not accept pull requests.
* To add new books, click on the purple + button at the bottom of the page. Enter an author's name or subject. Up to 20 items will be returned.

For details, check out [CONTRIBUTING.md](CONTRIBUTING.md).
![alt text](src/img/second.png)
Loading