-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
81 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,92 +1,31 @@ | ||
# MyReads Project | ||
# My Books Project | ||
Search for book titles and store them on rows of shelves with their own titles, 'currently reading, finished reading, and wish to read' | ||
|
||
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. | ||
# Installation | ||
In order to install and use this project you must run two commands in the console. | ||
1) npm install | ||
2) npm start | ||
|
||
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. | ||
These two commands will install all of the dependencies needed for this project and will start the server | ||
|
||
## TL;DR | ||
## Dependencies | ||
|
||
To get started developing right away: | ||
* npm/yarn | ||
|
||
* install all project dependencies with `npm install` | ||
* start the development server with `npm start` | ||
## Release History | ||
|
||
## 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. | ||
``` | ||
* 0.1.0 | ||
* The first proper release | ||
## Meta | ||
|
||
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. | ||
Your Name – [@br1xxx](https://twitter.com/br1xxx) – [email protected] | ||
|
||
## 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: `<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) | ||
``` | ||
|
||
* 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. | ||
|
||
## 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. | ||
|
||
## Create React App | ||
|
||
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). | ||
[https://github.com/Brienyll/my-books](https://github.com/Brienyll/) | ||
|
||
## Contributing | ||
|
||
This repository is the starter code for _all_ Udacity students. Therefore, we most likely will not accept pull requests. | ||
|
||
For details, check out [CONTRIBUTING.md](CONTRIBUTING.md). | ||
1. Fork it (<https://github.com/Brienyll/my-books/fork>) | ||
2. Create your feature branch (`git checkout -b feature/fooBar`) | ||
3. Commit your changes (`git commit -am 'Add some fooBar'`) | ||
4. Push to the branch (`git push origin feature/fooBar`) | ||
5. Create a new Pull Request |