My Reads Library

Keep track of your reading habit!
Udacity's React Nanodegree 1st Project

View Demo · Report Bug · Request Feature

                                     

Table of Contents

• About the Project
  • Live Demo
  • GIF Demo
  • User Experience
  • Built With
  • Important
  • Backend
    • Fetch
    • Upadate
    • Search
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Author
• Acknowledgements
• License

About The Project

Live Demo

GIF Demo

User Experience

My Reads allows you to search for books using specific search terms (found in SEARCH_TERMS.md). The books are stored in one of three bookshelves:

• Currently Reading
• Want to Read
• Read

The backend is provided by and run by Udacity.

Built With

• React - A JavaScript library for building user interfaces
• React Router - Declarative routing for React
• Redux - Predictable state container for JavaScript apps

Important

Starter project files by Udacity: https://github.com/udacity/reactnd-project-myreads-starter

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.

Backend

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()

• 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(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(query, maxResults)

• query: <String>
• maxResults: <Integer> Due to the nature of the backend server, search results are capped at 20, even if this is set higher.
• Returns a Promise which resolves to a JSON object containing a collection of 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.

Getting Started

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• yarn or npm, I highly recommand the former!

sudo apt update && sudo apt install yarn

npm install npm@latest -g

Installation

1. Clone the repo

git clone https://github.com/ilyeSudo/my-reads-library.git

2. Install project packages

yarn install

3. Launch the project and view it at localhost:3000

yarn start

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Author

• Ilyes Houdjedje - Linkedin - Github - Twitter

Acknowledgments

• Mr.Tyler McGinnis for the great course and to all the Udacity team!

License

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