emma-sg / RoboHome-Web

RoboHome-Web is the codebase that represents the frontend of the RoboHome project. The web interface provides a way to create users, add and manage devices, and an additional way to control devices.

RoboHome-Web

What Is RoboHome-Web?

This repo is one of a few repos that make up the whole project. RoboHome-Web is the codebase that represents the frontend of the RoboHome project. The web interface provides a way to create users, add and manage devices, and an additional way to control devices. RoboHome-Web is primarily built using PHP with Laravel for MVC and routing, MySQL for the database, and Bootstrap for layout and basic mobile support.

What Is the RoboHome Project?

RoboHome is a SaaS tool that also integrates with Amazon's Echo to enable control of semi-connected devices (think IR, and RF) in your house over wifi! This is done using an MQTT pub-sub network to send messages between the website or Echo to a microcontroller like the ESP8266 which has various transmitters hooked up to it (like IR and RF transmitters) to send signals to these devices. This can be used to control RF outlets with lights plugged into them, or to turn on your TV and change channels for instance.

Developing RoboHome-Web

Requirements ✅

1. Webserver with PHP 7.1 or greater with MySQL
2. SSL/TLS cert available for Free with Let's Encrypt. Note, we must use slightly less secure ciphers than the max due to hardware limitations of the ESP8266 which will need to talk to the RoboHome-Web API over HTTPS to gather information about devices. If set up correctly, by entering your website in SSL Lab's SSL Server Test, you should still get an "A" rating. To get the appropiate ciphers for your server visit Cipherli.st and click "Yes, give me a ciphersuite that works with legacy / old software."
3. MQTT broker for pub-sub. I personally use CloudMQTT. This service is used to send messages from a webservice to a microcontroller.
4. An account with Amazon to be used for account registration using OAuth.
5. An account with Login with Amazon to allow your website to use OAuth to verify users. Tip, be sure to register both www and non-www versions of URLs for the "Allowed JavaScript Origins."
6. Composer dependency manager for PHP

Configuring 🔧

1. Rename .env.example to .env and populate the information needed to connect to your MQTT broker and MySQL database (under DB_CONNECTION).
2. Run composer install from the root folder to download and install third-party PHP dependencies.

Docker 🐋

Docker support is currently on hold while the port to Laravel takes place.

This project uses Docker Compose to help easily emulate a test environment for rapid development and testing. This container has the PHP, MySQL, and phpMyAdmin services. For login to work, you'll need to add http://localhost to the "Allowed JavaScript Origins" in your Login With Amazon App Console. Once you have Docker installed and running, execute docker-compose up and visit http://localhost to view the website. To access phpMyAdmin, navigate to http://localhost:8183 and login with the following credentials; Server: db, user: root, password: password.

Contributing

How To Contribute 🎁

Contributions are always welcome! Please fork this repo and open a PR with your code or feel free to make an issue. All PRs will need to be reviewed and pass automated checks. If feedback is given on a PR, please submit updates to the original PR in the form of fixup! commits which will later be squashed before the PR is merged.

This repo supports the principles of Bob Martin's Clean Code.

Notes 📓

• Before you release this application...
  • If you're using Docker Compose, please take the time to update the username and default password to be more secure. The current implementation is designed for running this application locally.
  • Secure your Laravel installation by making the following changes to your .env file:
    • Change APP_ENV to production
    • Change APP_DEBUG to false