{"id":15095895,"url":"https://github.com/getz-devs/librakeeper-server","last_synced_at":"2026-01-02T23:05:35.434Z","repository":{"id":245344086,"uuid":"817853008","full_name":"getz-devs/librakeeper-server","owner":"getz-devs","description":"Robust Backend System for a Personal Book Library 📜","archived":false,"fork":false,"pushed_at":"2024-07-21T01:43:09.000Z","size":165,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-26T03:34:17.090Z","etag":null,"topics":["book-library","book-management","books","docker","docker-compose","firebase-auth","gin","golang","grpc","microservices","mongodb","rabbitmq","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getz-devs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-20T15:15:37.000Z","updated_at":"2024-07-28T03:18:19.000Z","dependencies_parsed_at":"2024-07-26T23:48:13.333Z","dependency_job_id":null,"html_url":"https://github.com/getz-devs/librakeeper-server","commit_stats":null,"previous_names":["getz-devs/librakeeper-server"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getz-devs%2Flibrakeeper-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getz-devs%2Flibrakeeper-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getz-devs%2Flibrakeeper-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getz-devs%2Flibrakeeper-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getz-devs","download_url":"https://codeload.github.com/getz-devs/librakeeper-server/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243801609,"owners_count":20350106,"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":["book-library","book-management","books","docker","docker-compose","firebase-auth","gin","golang","grpc","microservices","mongodb","rabbitmq","rest-api"],"created_at":"2024-09-25T15:43:28.539Z","updated_at":"2026-01-02T23:05:35.429Z","avatar_url":"https://github.com/getz-devs.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Librakeeper Server\n\n*― A Robust Backend System for a Personal Book Library*\n\nLibrakeeper Server is a backend system designed for managing a personal book library. It provides a robust set of\nfeatures, including user authentication, book management, bookshelf organization, and advanced search capabilities. The\nsystem is built using a microservices architecture with asynchronous processing, ensuring efficient and scalable\noperations.\n\n## Key Features\n\n* **User Authentication:** Secure authentication using Firebase.\n* **Book Management:** Add, view, update, and delete books with detailed information (ISBN, title, author, publishing,\n  description, cover image, and shop).\n* **Bookshelf Organization:** Create and manage personalized bookshelves to categorize books.\n* **Search Functionality:**  Find books by ISBN using simple (local database) or advanced (gRPC-based) search.\n* **Microservice Architecture:**  Leverage gRPC for efficient communication between the server, searcher, and\n  searcher-agent microservices.\n* **Asynchronous Processing:** Utilize RabbitMQ for asynchronous book searching and processing.\n* **Persistent Storage:**  Store book and bookshelf data in a MongoDB database.\n* **Containerization:**  Easy deployment and setup using Docker and Docker Compose.\n\n## API Documentation\n\nFor detailed information about the Librakeeper Server API, including available endpoints, data structures, and\nauthentication requirements, please refer to the comprehensive [API documentation](API.md).\n\n## Architecture Overview\n\nThe system follows a microservice architecture, with components communicating via gRPC and RabbitMQ.\n\n```mermaid\ngraph TB\n    Server[Librakeeper Server] -- gRPC --\u003e Searcher[Book Searcher Service]\n    Searcher -- RabbitMQ --\u003e SearcherAgent[Book Searcher Agent]\n    SearcherAgent -- HTTP --\u003e Websites[(External Websites)]\n    Server -- MongoDB --\u003e Database[(MongoDB Database)]\n    Searcher -- MongoDB --\u003e Database\n    SearcherAgent -- MongoDB --\u003e Database \n```\n\n## Getting Started\n\nHere's how to set up and run Librakeeper Server locally:\n\n### Prerequisites\n\n* **Go:**  [https://golang.org/](https://golang.org/)\n* **Docker:**  [https://www.docker.com/](https://www.docker.com/)\n* **Docker Compose:**  [https://docs.docker.com/compose/](https://docs.docker.com/compose/)\n* **MongoDB:**  [https://www.mongodb.com/](https://www.mongodb.com/)\n\n### Configuration\n\n1. **Configuration Files:**\n    - Configure the server, searcher, and searcher-agent microservices using the provided YAML configuration files (\n      e.g., `config/server/docker-local.yaml`).\n    - Update database connection details, RabbitMQ settings, and other relevant parameters in these files.\n2. **Firebase Credentials:**\n    - Obtain Firebase service account credentials (a JSON file).\n    - Place the credentials file in the `config/server` directory and reference it in the server's configuration\n      file (`auth.config_path`).\n\n### Installation\n\n1. **Clone the Repository:**\n   ```bash\n   git clone https://github.com/your-username/librakeeper-server.git\n   cd librakeeper-server\n   ```\n2. **Start Services:**\n    ```bash\n    docker-compose up -d\n    ```\n\n### Running the Server\n\nOnce the services are up and running, the Librakeeper Server will be accessible at `http://localhost:8080`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetz-devs%2Flibrakeeper-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetz-devs%2Flibrakeeper-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetz-devs%2Flibrakeeper-server/lists"}