MyReads - A Bookshelf App built with React

MyReads is a bookshelf application built with React for Udacity's React Nanodegree Program - React Fundamentals.

Demo

Checkout this live demo of the MyReads app. Once the simulator has launched, follow these instructions:

1. You can move a book by selecting which shelf you want the book to move to.
2. You can add a book by going to the search screen and searching by keywords. (There are keyword restrictions. View in the Restrictions section below for a list of the accepted keywords.).
3. Move the book to which shelf it belongs on.
4. Use the back button to see the new book added to the shelf that was selected.

Getting Started

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

Prerequisites

NODE AND NPM

You will need Node.js and npm on your local environment to download and run this application. Visit https://nodejs.org to learn the specifics on downloading, installing and running Node.js. npm is packaged with Node.js.

REACT

You will need ReactJS on your local environment to download and run this application. Visit https://reactjs.org/ to learn the specifics on downloading, intalling and running ReactJS.

Recommendations

YARN

It is recommended to use Yarn as the package manager for this project. Visit https://yarnpkg.com/en/ to learn the specifics on downloading, intalling and running Yarn.

Installing

Clone the project to your local environment

git clone https://github.com/edwdeapri/udacity-myreads

Change to the directory where the project is living on your local environment

cd udacity-myreads

Install dependencies with the package manager:

npm install

Start the application with the package manager:

npm start or yarn start

The MyReads application should now be open and running on the default browser.

Restrictions

The MyReads application has a search page where users can search books by keywords. The keywords are restricted to the following:

'Android', 'Art', 'Artificial Intelligence', 'Astronomy', 'Austen', 'Baseball', 'Basketball', 'Bhagat', 'Biography', 'Brief', 'Business', 'Camus', 'Cervantes', 'Christie', 'Classics', 'Comics', 'Cook', 'Cricket', 'Cycling', 'Desai', 'Design', 'Development', 'Digital Marketing', 'Drama', 'Drawing', 'Dumas', 'Education', 'Everything', 'Fantasy', 'Film', 'Finance', 'First', 'Fitness', 'Football', 'Future', 'Games', 'Gandhi', 'Homer', 'Horror', 'Hugo', 'Ibsen', 'Journey', 'Kafka', 'King', 'Lahiri', 'Larsson', 'Learn', 'Literary Fiction', 'Make', 'Manage', 'Marquez', 'Money', 'Mystery', 'Negotiate', 'Painting', 'Philosophy', 'Photography', 'Poetry', 'Production', 'Programming', 'React', 'Redux', 'River', 'Robotics', 'Rowling', 'Satire', 'Science Fiction', 'Shakespeare', 'Singh', 'Swimming', 'Tale', 'Thrun', 'Time', 'Tolstoy', 'Travel', 'Ultimate', 'Virtual Reality', 'Web Development', 'iOS'

Built With

• ReactJS - A JavaScript Framework

Versioning

For the versions available, see the tags on this repository.

Authors

• Edward Pritchard - Design / Development

License

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

Acknowledgments

• Colen Wilson for troubleshooting and testing the application during development.