Skip to content

A bookshelf app that allows to select and categorize books that user have read, are currently reading, or want to read.

Notifications You must be signed in to change notification settings

KushagraMehta/reactnd-project-myreads-starter

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MyReads Project

A bookshelf app that allows to select and categorize books that user have read, are currently reading, or want to read.

Demo

Demo animation

How to start

  1. Clone this repository
$> git clone https://github.com/KushagraMehta/reactnd-project-myreads-starter.git
  1. Install dependencies
$> cd ./book-tracking
$> yarn
  1. Start server
$> yarn start
  1. Open a browser and visit http://localhost:3000/

Backend Server

To simplify your development process, we've provided a backend server for you to develop against. The provided file BooksAPI.js contains the methods you will need to perform necessary operations on the backend:

getAll

Method Signature:

getAll();
  • Returns a Promise which resolves to a JSON object containing a collection of book objects.
  • This collection represents the books currently in the bookshelves in your app.

update

Method Signature:

update(book, shelf);
  • book: <Object> containing at minimum an id attribute
  • shelf: <String> contains one of ["wantToRead", "currentlyReading", "read"]
  • Returns a Promise which resolves to a JSON object containing the response data of the POST request

search

Method Signature:

search(query);
  • query: <String>
  • Returns a Promise which resolves to a JSON object containing a collection of a maximum of 20 book objects.
  • These books do not know which shelf they are on. They are raw results only. You'll need to make sure that books have the correct state while on the search page.

Available Search Terms

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, History, History, Homer, Horror, Hugo, Ibsen, Journey, Kafka, King, Lahiri, Larsson, Learn, Literary Fiction, Make, Manage, Marquez, Money, Mystery, Negotiate, Painting, Philosophy, Photography, Poetry, Production, Program Javascript, Programming, React, Redux, River, Robotics, Rowling, Satire, Science Fiction, Shakespeare, Singh, Swimming, Tale, Thrun, Time, Tolstoy, Travel, Ultimate, Virtual Reality, Web Development, iOS

About

A bookshelf app that allows to select and categorize books that user have read, are currently reading, or want to read.

Topics

Resources

Contributing

Stars

Watchers

Forks

Languages

  • JavaScript 72.0%
  • CSS 20.1%
  • HTML 7.9%