/reactnd-project-myreads-starter

MyReads Project - Nano degree React Developer

Primary LanguageJavaScript

MyReads Project

Project developed by me for Udacity Project in Nanodegree program - Developer React.

Enjoy!

Init Project

To get started developing right away:

  • install all project dependencies with npm install
  • start the development server with npm start

What You're Getting

├── 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. .
├── public
│   ├── favicon.ico # React Icon, You may change if you wish.
│   └── index.html # DO NOT MODIFY
└── src
    ├── App.css # Styles of app.
    ├── App.js # This is the root of app.
    ├── App.test.js # Used for testing.
    ├── Book.js # Component of Book, contains book information.
    ├── BookList.js # Component of BookList is a Shelf of Books that you have, contains all shelves with your book information.
    ├── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
    ├── Details.js # Component of Modal Details, contains all information about a specific book in a web modal.
    ├── Header.js # Component of Header, contains a Header of application with animation.
    ├── icons # Images for app. 
    │   ├── add.svg
    │   ├── arrow-back.svg
    │   └── arrow-drop-down.svg
    ├── index.css # Global styles.
    ├── index.js # Root file of application React.
    └── SearchBook.js # Component SearchBook, contains a web pag for find books in the API

Backend Server

The project use a API, that contains a Book information and functions. The provided file BooksAPI.js contains the methods you will need to perform necessary operations on the backend:

getAll

Method Signature:

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:

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:

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