Giter VIP home page Giter VIP logo

my-reads's Introduction

MyReads Project

A reading library application that allows the user to place books onto different shelves: Currently Reading, Want to Read, and Read. There is also a search functionality to add a new book to a certain shelf. In addition, the user can click on the Show Book Details button to reveal more information about a book including the average rating or preview link if available from the API.

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

├── CODEOWNERS # Using Udacity Starter Code
├── LICENSE.txt # Udacity Licensing Agreement
├── README.md # This file
├── SEARCHTERMS.md # The whitelisted short collection of available search terms for you to use with the app
├── package.json # npm package manager file
├── package-lock.json # dependency lock file
├── yarn.lock # dependency lock file
├── public
│   ├── favicon.ico # React Icon
│   └── index.html # DO NOT MODIFY
└── src
    └── components
    │   ├── App.js # Root of the app
    │   ├── Book.js # displays book information
    │   ├── BookDetailsModal.js # displays more book information
    │   ├── BookRatings.js # displays the average book rating with star icons
    │   ├── BooksGrid.js # displays multiple books 
    │   ├── Bookshelf.js # displays a BookGrid component based on the books on that shelf 
    │   ├── ChangeBookshelf.js # handles changing a book's shelf
    │   ├── ListBooks.js # displays all Bookshelf components 
    │   └── SearchBooks.js # displays a BookGrid component based on the query searched
    └── css
    │   ├── App.css # Styles for the app
    │   └── index.css # Global styles
    └── icons # Helpful images for the app
    │   ├── add.svg
    │   ├── arrow-back.svg
    │   ├── arrow-drop-down.svg
    │   └── default-thumbnail.svg
    └── utils
    │   └── BooksAPI.js # A JavaScript API for the provided Udacity backend. Instructions for the methods are below.
    └── 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.

Backend Server

To simplify the 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:

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 SEARCHTERMS.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. You can find more information on how to perform common tasks here.

my-reads's People

Contributors

rachelb8 avatar vsudacity avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.