/reactnd-myreads

The final project in the React Fundamentals portion of the React Nanodegree program

Primary LanguageJavaScript

MyReads

This project is the final project in the "React Fundamentals" course in the Udacity React Nanodegree.

Mockup

I created a basic mockup for the project to help me determine which components I would need to create.

See the (Figma MyReads Mockup)[https://www.figma.com/file/ZLr5F9fPXz5d6f3JPRhKXB5g/MyReads?node-id=0%3A1]

Installation

In order to run this application, first clone the repository and change directory into the application's root folder.

git clone https://github.com/bbez1/reactnd-myreads.git
cd reactnd-myreads/

Once you are in the project's root folder, install the dependencies using

yarn

Once the dependencies have finished installing, you can start the application by running:

yarn start

A new browser window will open displaying the app. If it does not open a new window, you can alternatively view the app by navigating to http://localhost:3000/

Usage

This application is intended to allow users to organize the books that they are currently reading, would like to read, or have already read. You may click the down carrot inside the circle of each book to toggle between these different states.

This application also allows for users to search a predefined set of search terms (found in the SEARCH_TERMS.md file). Each of the books that are in the search results can also be added to the main page so that they can be organized in the same manner as the default books.

Resources Used

License

This project is licensed under the terms of the MIT license.