Skip to content

HenryBrown0/udacity-react-myreads

Repository files navigation

MyReads Project

About

A simple book management web application for the Udacity Nanodegree course.

It allows you to:

  • Changing book shelves: To change a book shelf select the dropdown arrow on any book and select a new shelf.

  • Search for a book or author: To search for a book or author click the search icon in the bottom right corner and enter your search.

  • Get more information on a book: Click a book

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Prerequisites

You'll need to install the following software:

NodeJs v^14.0
Yarn v^1.22

Installing

A step by step series of examples that tell you how to get a development environment running.

Once the repo has been cloned, install the dependencies:

yarn install

Once the dependencies have been installed start the project:

yarn start

This will start the project locally on port 1234

Versioning

I use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details.