Skip to content

Latest commit

 

History

History
59 lines (39 loc) · 1.12 KB

README.md

File metadata and controls

59 lines (39 loc) · 1.12 KB
Raw

UDACITY's - REACT - My Reads App

The final project for REACT NanoDegree.

ABOUT

My Reads is a react application that categorizes books by shelves.

How does it is work

The main page: 'localhost:3000/' renders three types of bookshelves:

  • Currently reading
  • Want to read
  • Read

And the search page: 'localhost:3000' renders the result of the searched books and can add the book to your favorite bookshelf.

Technologies

  • HTML5
  • CSS3
  • SASS //in the second version 1.0.0
  • BEM //in the second version 1.0.0
  • tailwind //in the second version 1.0.0
  • React
  • GitHub
  • Bash
I will expand and implement styles in version 1.0.0

Installation

Use the package manager NPM to install foobar.

npm install  //To install dependencies
npm start    //To start the app
npm build    //To debloy the app

Usage

import * as bookAPI from './bookAPI'

# returns 'get all books items'
bookAPI.getAll()

# returns 'update book shelf'
bookAPI.update(book, shelf)

# returns 'searched items'
bookAPI.search(query)

Contributing

we most likely will not accept pull requests.