VR Real Estate Demo - App

This Flutter project is a demonstration of a VR Real Estate application. It includes features such as user authentication, device management, and estate browsing.

Table of Contents

• VR Real Estate Demo - App
  • Table of Contents
  • Project Structure
  • Setup
    • Prerequisites
    • Installation
      • Installing Flutter
        • macOS
        • Windows
      • Project Setup
  • Running the Project
  • Troubleshooting

Project Structure

The main project structure is as follows:

vrrealstatedemo/
├── android/
├── ios/
├── lib/
│   ├── screens/
│   │   ├── DevicesPage.dart
│   │   ├── EstatesPage.dart
│   │   ├── LoginPage.dart
│   │   └── ScenePage.dart
|   ├── utils/
│   │   ├── Progressbar.dart
│   │   └── SocketManager.dart
│   └── main.dart
├── assets/
│   └── app-icon.png
├── pubspec.yaml
├── README.md
└── .env

Setup

Prerequisites

Before you begin, ensure you have met the following requirements:

• Flutter SDK (latest stable version)
• Dart SDK
• Android Studio / Xcode (for iOS development)
• An IDE (e.g., VS Code, IntelliJ IDEA)

Installation

Installing Flutter

macOS

1. Download the Flutter SDK from the official Flutter website.

2. Extract the downloaded file in the desired location, e.g.:

   cd ~/development
   unzip ~/Downloads/flutter_macos_<version>-stable.zip

3. Add Flutter to your path:

   export PATH="$PATH:`pwd`/flutter/bin"

4. Run flutter doctor to check for any additional dependencies you may need to install.

Windows

1. Download the Flutter SDK from the official Flutter website.
2. Extract the zip file and place the contained flutter folder in the desired installation location for the Flutter SDK (e.g., C:\src\flutter).
3. Update your path:
   • From the Start search bar, type 'env' and select "Edit environment variables for your account"
   • Under "User variables" check if there is an entry called "Path"
   • If the entry exists, append the full path to flutter\bin using ; as a separator from existing values.
   • If the entry doesn't exist, create a new user variable named Path with the full path to flutter\bin as its value.
4. Run flutter doctor to check for any additional dependencies you may need to install.

Project Setup

1. Clone the repository:

   git clone https://github.com/wewerlive/vrrealstatedemo-app.git
   cd vrrealstatedemo-app

2. Install dependencies:

   flutter pub get

3. Set up environment variables:

   • Create a .env file in the root directory of the project
   • Add necessary environment variables (e.g., API endpoints, keys)

Running the Project

To run the project, use the following command:

flutter run

This will start the app on your connected device or emulator.

Troubleshooting

Here are some common issues you might encounter and how to resolve them:

1. "flutter command not found" error

   • Ensure Flutter is correctly added to your PATH.
   • Try restarting your terminal or IDE.

2. Build fails due to missing dependencies

   • Run flutter pub get to fetch all dependencies.

3. Android SDK not found

   • Ensure Android Studio is installed and the Android SDK is properly set up.
   • Run flutter doctor to check for any issues with Android setup.

4. iOS build fails

   • Ensure Xcode is installed (for macOS users).
   • Run sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer to set the correct Xcode path.

5. Socket.IO client connection issues

   • Check your internet connection.
   • Verify that the Socket.IO server URL in the .env file is correct.
   • Ensure the server is running and accessible.
   • Check for any CORS issues if connecting from a web client.

If you encounter any other issues, please check the Flutter documentation or open an issue in the project repository.