Skip to content

Latest commit

 

History

History
33 lines (20 loc) · 1.47 KB

README.md

File metadata and controls

33 lines (20 loc) · 1.47 KB

MyReads Project (udacity)

Description

This a bookshelf application that organizes the user's books into shelves which are the books you are currently reading, you have read and want to read. The application is written in React.js and uses an API for books provided by udacity.

Backend used

This application utilizes a backend provided by udacity to get data for books, here are the operations used from the backend:

getAll

This method was used to get all the books that are currently in the user's library, this helps to keep the same books on the shelves even when the application is refreshed

search

This method was used to search for books from the API that the user can add to their library

update

This method was used to update the current state of each on the user shelve, this was to make sure the state of the books was up to date when refreshing the application

Installation

  1. Clone project to your computer using the command git clone https://github.com/FearTheBeard95/myReadApp-udacity-project1.git
  2. Open your terminal application and go to the directory where the project was cloned and run the following commands
    1. npm install to install all the necessary dependencies required to run the app (Requires internet)
    2. npm run start to run the application
  3. Access the application on your local machine by going to this link localhost:3000