Welcome to the Dream House client-side repository! This is the front-end application for our real estate platform, where users can explore properties, search for their dream homes, and interact with various features like reviews, wishlists, and advertisements.
- Homepage: Displays a welcoming banner, featured properties, and advertisements.
- Property Search: Search properties by location and price range.
- Authentication: Login and register functionality using Firebase.
- Wishlist: Save favorite properties for later.
- Admin Dashboard: Manage properties, agents, and advertisements.
- Responsiveness: Fully responsive design optimized for all screen sizes.
- Frontend Framework: React.js
- CSS Framework: Tailwind CSS
- State Management: Context API
- API Calls: Axios
- Authentication: Firebase Authentication
- Routing: React Router
-
Clone the repository:
git clone https://github.com/your-username/dream-house-client.git
-
Navigate to the project directory:
cd dream-house-client -
Install dependencies:
npm install
-
Create a
.envfile in the root directory and add the following environment variables:REACT_APP_FIREBASE_API_KEY=your_firebase_api_key REACT_APP_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain REACT_APP_FIREBASE_PROJECT_ID=your_firebase_project_id REACT_APP_API_URL=http://localhost:5000
-
Start the development server:
npm start
The application will run at http://localhost:3000.
src
├── components
│ ├── Banner
│ ├── Navbar
│ ├── Footer
│ ├── PropertyCard
│ └── ...
├── pages
│ ├── Home
│ ├── Login
│ ├── Register
│ ├── Dashboard
│ └── ...
├── context
│ └── AuthContext.js
├── hooks
│ └── useAuth.js
├── utils
│ └── axiosInstance.js
├── App.js
├── index.js
└── ...
npm start: Runs the app in the development mode.npm run build: Builds the app for production.npm test: Launches the test runner.
- Fork the repository.
- Create a new branch:
git checkout -b feature-name
- Make your changes and commit:
git commit -m "Add your message here" - Push to the branch:
git push origin feature-name
- Open a pull request.
This project is licensed under the MIT License.
For any inquiries or support, please contact:
- Email: support@dreamhouse.com
- Website: Dream House
Thank you for contributing to Dream House!