Skip to content

MrMohammadMoradi/Saqfino

Repository files navigation

Saqfino Project 🏡

Welcome to the Saqfino Project! This repository is dedicated to building a modern, responsive, and user-friendly real estate platform based on the design from Figma. 🚀


🌟 Project Overview

This project is divided into two main parts:

  1. Frontend: Built with React + TypeScript, leveraging modern libraries and tools like:
    • TailwindCSS 🌈
    • Material-UI or Ant Design 🎨
  2. Backend: Powered by Python + Django, providing a robust API for seamless interaction.

Key Features:

  • 📱 Responsive Design: Optimized for all devices.
  • 🔍 Search Functionality: Find properties based on user-defined criteria.
  • 📊 Dynamic Data: Fetch and display data via APIs.
  • 🎛️ Modern UI: Elegant and intuitive user experience.

🛠️ Tech Stack

Frontend:

  • React ⚛️ (with TypeScript for type safety)
  • TailwindCSS 🌟 (utility-first styling framework)
  • Material-UI / Ant Design 🎨 (component libraries for a polished look)

Backend:

  • Python + Django 🐍 (for API and server-side logic)
  • Django REST Framework 🌐 (for building RESTful APIs)

📂 Folder Structure

saqfino/
├── frontend/       # Frontend code (React + TypeScript)
│   ├── src/
│   │   ├── components/   # Reusable React components
│   │   ├── pages/        # Page-level components
│   │   ├── assets/       # Images, icons, and other static files
│   │   └── styles/       # TailwindCSS configurations
│   └── package.json      # Frontend dependencies
├── backend/        # Backend code (Python + Django)
│   ├── api/
│   ├── models/
│   ├── serializers/
│   └── views/
└── README.md       # Project documentation

🚀 Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (v16 or later) 🌐
  • npm or yarn 📦
  • Python (v3.8 or later) 🐍
  • Django

Setup Instructions

Clone the Repository

git clone https://github.com/your-repo/saqfino.git
cd saqfino

Frontend Setup

  1. Navigate to the frontend directory:
    cd frontend
  2. Install dependencies:
    npm install
    # or
    yarn install
  3. Start the development server:
    npm start
    # or
    yarn start
  4. Open http://localhost:3000 to view the app.

Backend Setup

  1. Navigate to the backend directory:
    cd backend
  2. Create a virtual environment and activate it:
    python -m venv venv
    source venv/bin/activate
    # On Windows:
    # venv\Scripts\activate
  3. Install dependencies:
    pip install -r requirements.txt
  4. Run database migrations:
    python manage.py migrate
  5. Start the development server:
    python manage.py runserver
  6. Open http://127.0.0.1:8000 to access the backend.

🔄 API Integration

The frontend communicates with the backend using RESTful APIs. Key API endpoints:

Endpoint Method Description
/api/properties/ GET Fetch all properties
/api/properties/ POST Add a new property
/api/properties/:id GET Fetch property details
/api/properties/:id PUT Update property details
/api/properties/:id DELETE Delete a property

👥 Contributors


🌈 Design Inspiration

The design for this project is based on the amazing Figma template.


📄 License

This project is licensed under the MIT License.


📧 Contact

For any queries or suggestions, please contact:


🌟 Happy Coding! ✨