Skip to content

Latest commit

 

History

History
95 lines (67 loc) · 2.98 KB

README.md

File metadata and controls

95 lines (67 loc) · 2.98 KB

KAIRA App

KAIRA is an interactive web and desktop application designed to transform 2D floor plans into immersive 3D visualizations for homeowners, architects, and designers. The app allows users to preview layouts, experiment with furniture, and customize interiors before construction. The app integrates VR technology for a more engaging experience.

Features:

  • Interactive 3D visualization of floor plans.
  • VR support for immersive space planning.
  • Real-time layout editing and customization.
  • Cross-platform compatibility for both web and desktop (Electron).

Tech Stack:

  • Frontend: React.js, Three.js (for 3D rendering)
  • Backend: Node.js, Express
  • Database: MongoDB (for storing user data and layouts)
  • Electron: For desktop app version
  • VR: Integration with VR frameworks for immersive space planning.

Running the Web Application

  1. Clone the repository: First, clone the repository to your local machine if you haven't done so already:

    git clone https://github.com/your-username/kaira-app.git

  2. Install Dependencies: Navigate to the project directory and install the required dependencies for the web app:

    cd kaira-app
npm install

  3. Start the Development Server: Start the development server to view the web app in your browser:

    npm run dev

    This will launch the app at http://localhost:5173 by default. Open this URL in your browser to start using the KAIRA web app.

Running the Electron Application

To run the Electron app (desktop version):

  1. Ensure all dependencies are installed: If you haven't already installed the necessary dependencies, run:

    npm install

  2. Build the Electron App: To run the Electron app locally, use the following command:

    npm run electron

    This will open the KAIRA app in an Electron window. The app will have the same functionality as the web version but in a desktop environment.

Project Structure

  • /src: Contains all the frontend code and components for the app.
  • /public: Public assets such as images, icons, and static files.
  • /electron: Contains the code for the Electron desktop app.
  • /assets: Static assets like icons and logos used across the app.
  • package.json: The configuration file for managing dependencies and scripts.

Contributing

If you’d like to contribute to KAIRA, feel free to fork the repo and submit a pull request. Please make sure to follow the standard coding practices and include tests where applicable.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • React.js: For building the user interface.
  • Three.js: For 3D rendering.
  • Electron: For building the desktop app.
  • MongoDB: For managing data storage.

Feel free to reach out if you need any assistance or have any questions about the project!