{"id":15142620,"url":"https://github.com/mainbank5/estatebotics.v2","last_synced_at":"2026-04-01T20:29:08.378Z","repository":{"id":256895565,"uuid":"855000730","full_name":"MainBank5/estatebotics.v2","owner":"MainBank5","description":"EstateBotics v2 is a real estate chatbot powered by FastAPI and the OnOffice API, designed to help users search and retrieve property listings through a conversational interface. ","archived":false,"fork":false,"pushed_at":"2024-09-10T15:07:38.000Z","size":40,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-12T14:49:20.025Z","etag":null,"topics":["ai","artificial-intelligence","bot","fastapi","python3"],"latest_commit_sha":null,"homepage":"","language":"Python","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/MainBank5.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-09-10T06:09:17.000Z","updated_at":"2025-01-04T12:10:10.000Z","dependencies_parsed_at":"2024-09-13T17:48:14.272Z","dependency_job_id":"32adf00e-eb5d-4362-a39e-c7dd82922e16","html_url":"https://github.com/MainBank5/estatebotics.v2","commit_stats":null,"previous_names":["mainbank5/estatebotics.v2"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MainBank5%2Festatebotics.v2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MainBank5%2Festatebotics.v2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MainBank5%2Festatebotics.v2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MainBank5%2Festatebotics.v2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MainBank5","download_url":"https://codeload.github.com/MainBank5/estatebotics.v2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246368676,"owners_count":20766062,"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":["ai","artificial-intelligence","bot","fastapi","python3"],"created_at":"2024-09-26T09:43:10.704Z","updated_at":"2025-12-25T10:49:12.286Z","avatar_url":"https://github.com/MainBank5.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# EstateBotics v2\n\nEstateBotics v2 is a real estate chatbot powered by FastAPI and the OnOffice API, designed to help users search and retrieve property listings through a conversational interface. The chatbot is integrated with OpenAI's GPT to provide an intuitive and seamless user experience.\n\n## Table of Contents\n- [Features](#features)\n- [Tech Stack](#tech-stack)\n- [Getting Started](#getting-started)\n- [Project Structure](#project-structure)\n- [API Endpoints](#api-endpoints)\n- [Environment Variables](#environment-variables)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n- Fast and scalable backend powered by **FastAPI**.\n- **OnOffice API** integration to fetch and search real estate properties.\n- Conversational chatbot interface powered by **OpenAI GPT**.\n- Secure environment with **API token and HMAC** for authenticating API requests.\n- Extensible design allowing easy addition of new features and integrations.\n\n## Tech Stack\n- **Backend**: FastAPI, Python\n- **Frontend**: React.js\n- **Database**: OnOffice API (for property data), PostgreSQL\n- **Other**: OpenAI GPT for chatbot responses, HMAC authentication, GitHub for version control\n\n## Getting Started\n\nFollow the steps below to set up the project on your local machine:\n\n### Prerequisites\n- Python 3.x\n- Git\n- A GitHub account\n- OnOffice API credentials (API token and secret)\n- OpenAI API key\n\n### Installation\n\n1. Clone the repository:\n\n    ```bash\n    git clone https://github.com/MainBank5/estatebotics.v2.git\n    cd estatebotics.v2\n    ```\n\n2. Set up a virtual environment:\n\n    ```bash\n    python -m venv .venv\n    source .venv/bin/activate  # On Windows, use .venv\\Scripts\\activate\n    ```\n\n3. Install the required packages:\n\n    ```bash\n    pip install -r requirements.txt\n    ```\n\n4. Set up environment variables:\n\n    Create a `.env` file in the root of the project and add your API credentials as shown in the example below.\n\n    `.env` Example:\n\n    ```env\n    ONOFFICE_API_TOKEN=your_onoffice_api_token\n    ONOFFICE_API_SECRET=your_onoffice_api_secret\n    OPENAI_API_KEY=your_openai_api_key\n    ```\n\n5. Run the application:\n\n    ```bash\n    uvicorn main:app --reload\n    ```\n\n   Open your browser and navigate to [http://127.0.0.1:8000/docs](http://127.0.0.1:8000/docs) to view the automatically generated FastAPI documentation.\n\n## Project Structure\n\n```estatebotics.v2/ ├── .venv/ # Virtual environment (not included in Git) ├── .env # Environment variables (not included in Git) ├── pycache/ # Compiled Python files (not included in Git) ├── main.py # Main FastAPI application entry point ├── chatbot_service.py # Chatbot service logic (integrates with OpenAI GPT) ├── onoffice_service.py # OnOffice API integration logic ├── requirements.txt # Project dependencies ├── .gitignore # Git ignore file └── README.md # Project documentation```\n\n\n## API Endpoints\n\nHere are the core endpoints for interacting with the chatbot and OnOffice API.\n\n- **GET /properties**\n\n  Fetches all properties from the OnOffice API based on filters (e.g., location, price).\n\n- **POST /chatbot**\n\n  Interacts with the chatbot to respond to user queries.\n\n  **Body:**\n\n    ```json\n    {\n      \"message\": \"Search for properties in Berlin\"\n    }\n    ```\n\n- **GET /docs**\n\n  Interactive API documentation using FastAPI's automatic documentation system.\n\n## Environment Variables\n\n- `ONOFFICE_API_TOKEN`: Your OnOffice API token for authentication.\n- `ONOFFICE_API_SECRET`: Your OnOffice API secret for HMAC calculation.\n- `OPENAI_API_KEY`: Your OpenAI API key for the chatbot integration.\n\nMake sure to create a `.env` file in your project root and store these credentials securely.\n\n## Contributing\n\nWe welcome contributions! To contribute:\n\n1. Fork the repository.\n2. Create a new branch (`git checkout -b feature-name`).\n3. Make your changes and commit (`git commit -m \"Add new feature\"`).\n4. Push to the branch (`git push origin feature-name`).\n5. Open a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## Contact\n\nFor any questions or support, feel free to contact me at eliudkaruga97@gmail.com.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainbank5%2Festatebotics.v2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmainbank5%2Festatebotics.v2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmainbank5%2Festatebotics.v2/lists"}