Books Hut

An awesome website to read all your favorite books and save them!

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Prerequisites
3. Installation
4. Contributing
5. License
6. Contact

About The Project

Having trouble finding time to read your favorite book? Books Hut is a free, big library with a wide range of books, from Philosophy to the Computer Science! All you have to do is create your account, add books to your personal library, and start reading!

Reading a book from beginning to end is not always possible with work, family, and other commitments. Books Hut allows you to read books in between your busy schedule. Why rush through a good book? Read it at your own pace and store them in your library for future reference. With a wide-range of books, our library has everything you're looking for.

Deployed Frontend

Deployed Backend

(back to top)

Built With

This section lists all major technologies used to bootstrap our project.

• 
• 
• 
• 
• 

(back to top)

Prerequisites

This is an list of things you need to have to run application.

• Redis
• PostgreSQL

Installation

Below is an example of how you can install and setup our app.

1. Clone the repo

   git clone https://github.com/chingu-voyages/v40-bears-team-28.git

2. Install NPM packages in client and server folders

   npm install

3. Go to docs/REQUIREMENTS.md and follow instructions about creating database
4. Start server

   cd Books/server
   npm run dev

5. Start client

   cd Books/client
   npm start

6. Go to http://localhost:3000/

(back to top)

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". Don't forget to give the project a star! Thanks again!

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Dmitry Kulakov - @AtomEistee - [email protected]

(back to top)