https://github.com/dimamik/what-to-read
Spotify for the books. Uses collaborative filtering to find you books to read based on your previous reads
https://github.com/dimamik/what-to-read
docker-compose elasticsearch flask react
Last synced: 3 months ago
JSON representation
Spotify for the books. Uses collaborative filtering to find you books to read based on your previous reads
- Host: GitHub
- URL: https://github.com/dimamik/what-to-read
- Owner: dimamik
- License: gpl-3.0
- Created: 2021-08-14T21:27:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-10-06T21:57:16.000Z (over 4 years ago)
- Last Synced: 2025-10-25T08:50:40.131Z (8 months ago)
- Topics: docker-compose, elasticsearch, flask, react
- Language: Python
- Homepage:
- Size: 10.4 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
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
## 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](https://reactjs.org/)
* Back - [Python Flask](https://flask.palletsprojects.com/en/2.0.x/)
* Database - [Elasticsearch](https://www.elastic.co/)
* Web Server Interface - [UWSGI](https://uwsgi-docs.readthedocs.io/en/latest/)
* Reversed proxy - [NGINX](https://www.nginx.com/)
* 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
```sh
git clone https://github.com/dimamik/what-to-read.git
```
2. Run docker-compose
```sh
cd what-to-read
docker-compose up --build
```
## Roadmap
See the [open issues](https://github.com/dimamik/what-to-read/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](https://github.com/dimamik/what-to-read)
[contributors-shield]: https://img.shields.io/github/contributors/dimamik/what-to-read?style=for-the-badge
[contributors-url]: https://github.com/dimamik/what-to-read/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/dimamik/what-to-read?style=for-the-badge
[forks-url]: https://github.com/dimamik/what-to-read/network/members
[stars-shield]: https://img.shields.io/github/stars/dimamik/what-to-read?style=for-the-badge
[stars-url]: https://github.com/dimamik/what-to-read/stargazers
[issues-shield]: https://img.shields.io/github/issues/dimamik/what-to-read?style=for-the-badge
[issues-url]: https://github.com/dimamik/what-to-read/issues
[license-shield]: https://img.shields.io/github/license/dimamik/what-to-read?style=for-the-badge
[license-url]: https://github.com/dimamik/what-to-read/blob/master/LICENSE