What To Read

Single Page Application designed to help you find a book to read having books you have read before.
Based on Collaborative filtering technique

Report Bug · Request Feature

Table of Contents

1. Project Structure
2. Build With
3. Getting Started
   • Prerequisites
   • Installation
4. Usage
5. Roadmap
6. Contributing
7. License
8. Contact

Project Structure

├── nginx - reversed proxy
├── ui - React Front
├── rec_api - REST API server handling recommendations
├── search_api - REST API server handling books searching
└── img - images for Readme.md

Built With

• Front - React
• Back - Python Flask
• Database - Elasticsearch
• Web Server Interface - UWSGI
• Reversed proxy - NGINX
• Docker-compose

Getting Started

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

Prerequisites

docker-compose and git installed on server with open ip adress and ports 80,5000,5001

Installation

1. Clone the repo

   git clone https://github.com/dimamik/what-to-read.git

2. Run docker-compose

   cd what-to-read
   docker-compose up --build

Roadmap

See the open issues for a list of proposed features (and known issues).

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.

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

Distributed under the GPL-3.0.
See LICENSE for more information.

Contact

Project Link: https://github.com/dimamik/what-to-read