Skip to content

06

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

06

README.md

MyReads: A Book Lending App

This project is a part of Front-End Web Developer course. Project contains application for tracking book you've read, reading or want to read in future. Project focused on proper usage of React components state management.

Getting Started

  1. Acquire project:
    • (easy) use online version hosted on GitHub pages;
    • (preferable) download the source code archive;
    • (advanced) you could also clone a git subtree from GitHub;
  2. Make sure NodeJS installed on your machine.
  3. Run npm run start or yarn start to start development server
  4. The script should automatically open the page.

Create React App

This project was bootstrapped with Create React App + react-scripts-ts for typescript support. You can find more information on how to perform common tasks here.

Backend Server

To simplify your development process, we've provided a backend server for you to develop against. The provided file books-api.ts 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.

Important

The backend API uses a fixed set of cached search results and is limited to a particular set of search terms, which can be found in SEARCH_TERMS.md. That list of terms are the only terms that will work with the backend, so don't be surprised if your searches for Basket Weaving or Bubble Wrap don't come back with any results.

Contributing

Project has strictly education purposes and will no accept any pull requests.

Authors

License

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