🏠 Baytak

Baytak is a modern real estate platform built with Ruby on Rails, designed to streamline the management of property listings and projects. It offers a user-friendly interface for real estate agencies and developers to showcase properties and projects effectively.

📌 Table of Contents

• Features
• Tech Stack
• Demo
• Getting Started
• Usage
• Contributing
• License
• Contact

✨ Features

• Project Management: Create and manage real estate projects with details like location, developer, status, total units, and completion dates.
• Property Listings: Add properties with attributes such as area, price, bedrooms, bathrooms, floor number, and delivery dates.
• Rich Text Descriptions: Utilize rich text editors for detailed property and project descriptions.
• Image Uploads: Upload multiple images for properties and projects to provide visual context.
• Responsive Design: Mobile-friendly interface with Tailwind CSS for seamless user experience across devices.
• Validation and Error Handling: Robust form validations with user-friendly error messages.
• AI Powered Assistant Baytak is enhanced with AI powered assistant that integrated with app database to improve user experience
• Health Checks Added healthchecks to the server using allgood gem

🛠 Tech Stack

• Backend: Ruby on Rails
• Frontend: Tailwind CSS
• Database: PostgreSQL
• Authentication: Devise
• File Uploads: Active Storage
• Rich Text Editor: Action Text

👀 Demo

🚀 Getting Started

Prerequisites

Ensure you have the following installed:

• Ruby (version 3.0.0 or higher)
• Rails (version 8.0 or higher)
• SQLite3

Installation

1. Clone the repository:

   git clone https://github.com/essam-tobgi-dev/baytak.git
   cd baytak

2. Install dependencies:

   bundle install

3. Set up the database:

   rails db:create
   rails db:migrate

4. Start the Rails server:

   rails server

   Visit http://localhost:3000 in your browser to access the application.

📖 Usage

• Projects: Navigate to the Projects section to add new projects with relevant details and images.
• Properties: Within each project, add properties specifying attributes like area, price, and images.
• Editing: Use the edit functionality to update project or property details.
• Viewing: View detailed pages for each project and property, showcasing all associated information and images.

🤝 Contributing

Contributions are welcome! To contribute:

1. Fork the repository.

2. Create a new branch:

   git checkout -b feature/your-feature-name

3. Make your changes and commit them:

   git commit -m "Add your message here"

4. Push to your forked repository:

   git push origin feature/your-feature-name

5. Create a Pull Request.

Please ensure your code adheres to the project's coding standards and includes appropriate tests.

📄 License

This project is licensed under the MIT License.

📬 Contact

For questions or suggestions, feel free to reach out:

• LinkedIn: essam-eltobgi