/gutenbook

Primary LanguageJavaScript

📗 Table of Contents

📖 [GutenBücher]

GutenBücher is a React-Redux webapp using the Gutendex API to get access to the Gutenber Project library of more 60,000 free books. The app allows to search books by topic, title/author and language. It also links to the HTML readable version of the selected book. The listings are sorted by popularity according to the number of downloads they get

Screenshot

screenshot

🛠 Built With

Tech Stack

Functionality
Front End
Styling

Key Features

  • Single page app
  • Books listing with filtering and search functionality
  • Book details with direct access to a readable html version

(back to top)

🚀 Live Demo

  • Check the live demo here
  • Check a video demo here

(back to top)

💻 Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

In order to run this project you need:

NodeJS v16.13 NPM v8.7

Setup

Clone this repository to your desired folder:

    cd my-folder
    git clone git@github.com:gdumani/gutenbook.git
    cd gutenbook
    git checkout feat/struct

Install dependencies:

    npm install

Available Scripts

In the project directory, you can run:

npm start

Runs the app in development mode. Open http://localhost:3000/ to view it in your browser.

The page will reload when you make changes.
You may also see any lint errors in the console.

npm test

Launches the test runner in the interactive watch mode.

npm run build

Builds the app for production to the dist folder.
The build is minified and the filenames include the hashes.
Your app is ready to be deployed!

Usage

To run the project open the html file in your web browser. The application format is optimized to run on a mobile phone

(back to top)

👥 Author

👤 Giancarlo Dumani

(back to top)

🔭 Future Features

  • Refine search and filtering with pull downs for topics and languages
  • Add option to download books in epub or pdf format
  • Include other sorting options

(back to top)

🤝 Contributing

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

(back to top)

⭐️ Show your support

If you like this project feel free to give it a star.

(back to top)

🙏 Acknowledgments

The Gutenberg Project for providing this amazing library. Gareth B. Johnson provided the Gutendex API Original design idea by Nelson Sakwa on Behance.
Microverse for inpiring this project and giving the guidelines to develope it.

(back to top)

❓ FAQ

  • Can I contribute to the project?

    • Yes. By all means feel free to clone the repository and make your changes. (Always use a new branch)

  • Can I use this application freely?

    • You can use the application as long as you give credit where it is needed.

(back to top)

📝 License

This project is MIT licensed.

(back to top)