Getting Started

Welcome! This guide will help you set up and use Open Estate AI projects.

Prerequisites

• Python 3.11+
• Node.js and npm (for AWS CDK)
• AWS CLI configured (aws configure)
• Terraform (if using infra-as-code)
• An AWS account with suitable permissions

Quick Setup

1. Clone the repository:

   git clone https://github.com/open-estate-ai/real-estate-docs.git
   

2. Create and activate a Python virtual environment:

   python3 -m venv .venv
   source .venv/bin/activate
   

3. Install dependencies:

   pip install -r requirements.txt
   

4. For documentation:

   mkdocs serve
   

5. For infrastructure:

6. See the Guides and Reference sections for details.

Need Help?

• Join our Slack
• Open an issue on GitHub

---

Feel free to suggest improvements or ask questions!