Immersive-Home

(β˜… 556)

Mixed reality experience for interacting with your smart home in a new dimension.

  • .gitignore
  • CODE_OF_CONDUCT.md
  • hacs.json
  • LICENSE
  • README.md
  • thesis.pdf

# Installation Guide

1. Get the code
git clone https://github.com/Nitwel/Immersive-Home

Downloads the entire project code from GitHub to your computer.

cd Immersive-Home

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -f docs/Dockerfile -t immersive-home .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 immersive-home

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
cd docs

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation