MyReads: Book Tracking App (React)

This app allows users to select books from a library and organize them into shelves. The Books are then stored in a back-end database and received on load. This project was bootstrapped with Create React App. Below you will find some information on how to run the app.

Table of Contents

• Demo
• Implementation
• Deployment
• Technologies
• License

Demo

App is currently live: https://ziwam.github.io/MyReads/

Implementation

To clone this repository you need Git, Node and Node's package manager (npm) installed on your computer.

Dependencies

"dependencies": {
    "node-sass-chokidar": "^1.2.2",
    "npm-run-all": "^4.1.2",
    "react": "^16.2.0",
    "react-dom": "^16.2.0",
    "react-router-dom": "^4.2.2",
    "react-scripts": "1.1.0"
}

Installation

# clone the repo
$ git clone https://github.com/Ziwam/MyReads.git

# go into the repo
$ cd myreads

# install the dependencies
$ npm install

# start the app
$ npm run start

The app should be running on http://localhost:3000

Deployment

Create a development-ready build be running.

$ npm run build

Technologies

This project includes:

• React
• Udacity's Book Database - database is very limited
• Sass

Acknowledgements

I would like to thank rafrex for the gist I included in index.html. The gist allows GitHub pages and react-router to coexist, Rerouting the app back to the correct URL whenever a redirect is detected.

License

(MIT License) The MIT License (MIT) Copyright (c) 2018 Ziwa Mukungu zmukungu@gmail.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.