idati / myreads Goto Github PK

This is a Udacity Project "My Reads: A Book Tracking App", check out at www.udacity.com

It should teach the React Fundamentals by doing this Project. My personal experience was very good. It gives a good start to learn React.

If you like to see the result please check if you have installed notes, mpn and git. If so go on with

1. git clone https://github.com/idati/myreads.git

2. cd myreads

3. mpn install

4. mpn start

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.

To simplify your development process, we've provided a backend server for you to develop against. The provided file BooksAPI.js contains the methods you will need to perform necessary operations on the backend:

• 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.

• 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

• query: <String>
• maxResults: <Integer> Due to the nature of the backend server, search results are capped at 20, even if this is set higher.
• Returns a Promise which resolves to a JSON object containing a collection of 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.

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. 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.

This project was bootstrapped with Create React App. You can find more information on how to perform common tasks here.

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.