RoomScout

RoomScout is a platform for connecting students and landlords, providing a seamless rental experience for both parties.

Table of Contents

• Features

• Installation

• Usage

• Testing

• Project Structure

• Technologies Used

• Contributing

• License

Features

• User authentication and profile setup

• Property listings with detailed information

• Wishlist functionality for users

• Property comparison

• Responsive design

• Integration with Google Maps

Installation

1. Clone the repository:

   git clone https://github.com/yourusername/roomscout.git
   
   cd roomscout
   

2. Install dependencies:

   pnpm install
   

3. Create a .env.local file and add your environment variables:

   REACT_APP_API_BASE_URL=https://your-api-url.com

Usage

1. Start the development server:
2. Build the project for production:
3. Preview the production build:

Testing

1. Run the tests:
2. Run the tests in watch mode:

Technologies Used:

• React
• Vite
• Redux Toolkit
• Ant Design
• Axios
• Formik
• Yup
• Google Maps API
• Jest
• React Testing Library
• Vitest

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (git checkout -b feature-branch).
3. Make your changes.
4. Commit your changes (git commit -m 'Add some feature').
5. Push to the branch (git push origin feature-branch).
6. Open a pull request.

License

This project is licensed under the MIT License.