Skip to content

Tablet responsive web App for users who would like to read free classical books on the go. Using the Gutendex API, we pull books from the Gutenberg Project epub database and display them using React Reader (powered by ePubJS).

License

Notifications You must be signed in to change notification settings

berta-rf/gutenBooks

Repository files navigation

Netlify Status GitHub License


React React Router MUI AWS Lambda SCSS Netlify npm JS Node.js Axios


🎯 Description

gutenBooks is a responsive web App for users who would like to read free classical books on the go. Using the Gutendex API, we pull books from the Gutenberg Project epub database and display them using React Reader (powered by ePubJS).

The app allows you to filter your search by author / title or by topic, read the book directly or add it to your Bookshelf for later. There's also a Reviews section for you to keep track of your read books with star rating and review functionality.

This web app was build with React, MUI components, styled with SCSS, uses an AWS Lambda function and is deployed on Netlify.

gutenBooks


Table of Contents


🛠 Installation

To use this application you will need to install dependencies by entering the following command on your terminal:

npm install

💻 Usage

The application is invoked by entering the following command on your terminal:

npm start

For the Netlify function to work in development, you will have to install Netflify CLI environment with this command: (see detailed info here: https://docs.netlify.com/cli/get-started/#installation)

npm install netlify-cli -g

💬 Questions

Contact us if you have any questions!


🤝 Credits


💪 Contributing

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

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  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

📖 License

This project is licensed under the terms of the MIT License. See LICENSE for more information.

About

Tablet responsive web App for users who would like to read free classical books on the go. Using the Gutendex API, we pull books from the Gutenberg Project epub database and display them using React Reader (powered by ePubJS).

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages