{"id":28490738,"url":"https://github.com/gixproject/esbook","last_synced_at":"2026-04-09T11:03:09.506Z","repository":{"id":44702808,"uuid":"313916817","full_name":"gixproject/esbook","owner":"gixproject","description":"Flask boilerplate REST API application based on Docker that provides search capabilities using ElasticSearch","archived":false,"fork":false,"pushed_at":"2022-01-30T09:35:28.000Z","size":134,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"develop","last_synced_at":"2025-06-26T10:04:01.042Z","etag":null,"topics":["black","docker","elasticsearch","flask","gunicorn","poetry","postgresql","rest-api","sqlalchemy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gixproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-18T11:41:55.000Z","updated_at":"2024-10-28T15:25:35.000Z","dependencies_parsed_at":"2022-09-11T19:21:45.468Z","dependency_job_id":null,"html_url":"https://github.com/gixproject/esbook","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/gixproject/esbook","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gixproject%2Fesbook","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gixproject%2Fesbook/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gixproject%2Fesbook/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gixproject%2Fesbook/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gixproject","download_url":"https://codeload.github.com/gixproject/esbook/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gixproject%2Fesbook/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265297051,"owners_count":23742585,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["black","docker","elasticsearch","flask","gunicorn","poetry","postgresql","rest-api","sqlalchemy"],"created_at":"2025-06-08T07:10:06.898Z","updated_at":"2025-12-30T22:07:33.760Z","avatar_url":"https://github.com/gixproject.png","language":"Python","readme":"# ESbook\n\n[![Build Status](https://travis-ci.org/gixproject/esbook.svg)](https://travis-ci.org/gixproject/esbook)\n[![License](https://img.shields.io/github/license/gixproject/esbook)](http://www.apache.org/licenses/LICENSE-2.0)\n[![Coverage Status](https://coveralls.io/repos/github/gixproject/esbook/badge.svg)](https://coveralls.io/github/gixproject/esbook)\n[![Code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)\n\n## Description\nThe boilerplate Flask application that provides search within books.\n\nThe API represents results in a suitable JSON format that can be helpful to other developers and companies.  \nIt allows you to retrieve data for a period or just by one author. \nPeriodical updates help to keep the data fresh.  \n\n### Libraries and tools\n* Docker + compose\n* Poetry package manager\n* Flask Framework\n* Flask-restplus\n* PostgreSQL\n* SQLAlchemy\n* ElasticSearch\n* gunicorn \n* unittest + pytest\n* invoke\n\n## Setup\nMake sure **Docker** is installed on your system\n\n1. Copy `.env.example` file content to `.env`\n2. `make build \u0026\u0026 make up` \n3. Open `localhost:5000`\n\nPay attention that the config file already has default values\n\n## Useful actions\n### Commands\n**To run commands use** `make exec` to execute web container  \nTo see all commands type `python manage.py`  \n\nConfigure the project with test data:  \n`manage.py apply_test_data`\n\nMigrate existing books to ElasticSearch:  \n`python manage.py migrate_books_to_es`\n\nTo see all URL's:  \n`python manage.py show_urls`\n\nTo recreate database schema use:  \n`python manage.py reset_db`\n\n### Make commands support\nFor details type `make help`  \n\n### Testing\nRun tests `make test`  \nRun lint `make lint`\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgixproject%2Fesbook","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgixproject%2Fesbook","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgixproject%2Fesbook/lists"}