Skip to content

yegres280/biblus

Repository files navigation

Biblus

CI: Biblus

The service for finding and dowloading books using Onion Network.

Table of Contents

Technology Stack

nginx docker Github Actions python pydantic pytest fastapi redis ElasticSearch TOR Bash

DEMO

Downloading Demo

Dowloading

Get Methods Demo

Get_methods:Books

Features

  1. API built with FastAPI
  2. Strong typization with pydantic and standart python library
  3. Intergrational tests with pytest
  4. CI/CD: Linting, Docker Compose, Tests in Github Actions
  5. Elasticsearch stores data about books in JSON format. The storage is easily replacable
  6. A user can find books using Full Text Search and get download links for a certain book
  7. The user can download a book directly from the app if there is a Tor link for a book in a storage so app can download a file and give it to a user
  8. The service is easily deployed using Docker Compose
  9. Caching with Redis (replacable) and FastAPI-Cache
  10. Nginx as web-server

Installation

Docker Compose installation:

  1. Clone the repository:
 git clone https://github.com/yegres280/biblus.git
  1. Build Docker Compose:
 docker compose up -d

Local installation

  1. Clone the repository:
 git clone https://github.com/yegres280/biblus.git
  1. Install dependencies:
 cd biblus/src/ && python -m venv .venv && cd .. && pip install -r requirements/local.txt

Usage

  1. Launch
 cd src && python main.py

License

This project is licensed under the MIT

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published