Giter Club home page Giter Club logo

udacity-react-my_reads's Introduction

My Reads Project (Udacity)

Build Status

This project is my variant of the My Reads project created for Udacity's React course. It is a simple bookshelf management system with its own bookshelf and a possibility to integrate books from a provided API.

Installation

How to start the application:

  • Navigate to the correct folder
cd starter
  • Install all required project dependencies
npm i
  • Start the Development Server
npm start

Preview

Your own Bookshelf

Bildschirmfoto 2022-08-09 um 13 40 56

Choose the status of your books

Bildschirmfoto 2022-08-09 um 13 44 00

Search and add new Books

Bildschirmfoto 2022-08-09 um 13 41 26 Bildschirmfoto 2022-08-09 um 13 41 40

File-structure

├── CONTRIBUTING.md
├── README.md 
├── SEARCH_TERMS.md 
├── package.json 
├── public
│   ├── favicon.ico
│   └── index.html 
├── src
│   ├── App.css
│   ├── App.js
│   ├── Book.js
│   ├── BookShelf.js
│   ├── BookShelfChanger.js
│   ├── BookShelfTray.js
│   ├── SearchBookPage.js
│   ├── icons
│   │   ├── add.svg
│   │   ├── arrow-back.svg
│   │   └── arrow-drop-down.svg
│   ├── index.css
│   ├── index.js
│   └── utils
│       └── BooksAPI.js
└── yarn.lock

Backend API

The API provided by Udacity contains a small database of books that can be searched and added.

⚠️ It is important to note that the database behind the api is for demo purposes only and does not reflect a real time library database. (More infos:Important)

There are 4 possible requests to the API:

1️⃣get

Method Signature:

get(bookID);
  • bookID: <String> containing any available book id attribute (e.g. "1wy49i-gQjIC")
  • Returns a Promise which resolves to a JSON object containing a single book object matching the bookID.

2️⃣getAll

Method Signature:

getAll();
  • Returns a Promise which resolves to a JSON object containing a collection of book objects.

3️⃣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

4️⃣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.

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.

Create React App

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

Contributing

This repository was created based on the entry code for all Udacity students.

For details, check out CONTRIBUTING.md.

udacity-react-my_reads's People

Contributors

marvinlaubenstein avatar vsudacity avatar sudkul 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.