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. 🚀
This project is divided into two main parts:
- Frontend: Built with React + TypeScript, leveraging modern libraries and tools like:
- TailwindCSS 🌈
- Material-UI or Ant Design 🎨
- Backend: Powered by Python + Django, providing a robust API for seamless interaction.
- 📱 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.
- React ⚛️ (with TypeScript for type safety)
- TailwindCSS 🌟 (utility-first styling framework)
- Material-UI / Ant Design 🎨 (component libraries for a polished look)
- Python + Django 🐍 (for API and server-side logic)
- Django REST Framework 🌐 (for building RESTful APIs)
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
Ensure you have the following installed:
- Node.js (v16 or later) 🌐
- npm or yarn 📦
- Python (v3.8 or later) 🐍
- Django
git clone https://github.com/your-repo/saqfino.git
cd saqfino
- Navigate to the frontend directory:
cd frontend
- Install dependencies:
npm install # or yarn install
- Start the development server:
npm start # or yarn start
- Open http://localhost:3000 to view the app.
- Navigate to the backend directory:
cd backend
- Create a virtual environment and activate it:
python -m venv venv source venv/bin/activate # On Windows: # venv\Scripts\activate
- Install dependencies:
pip install -r requirements.txt
- Run database migrations:
python manage.py migrate
- Start the development server:
python manage.py runserver
- Open http://127.0.0.1:8000 to access the backend.
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 |
- Frontend Developer: Your Name 💻
- Backend Developer: Your Friend's Name 🔧
The design for this project is based on the amazing Figma template.
This project is licensed under the MIT License.
For any queries or suggestions, please contact:
- Email: [email protected]
- LinkedIn: Your LinkedIn Profile
🌟 Happy Coding! ✨