GEORGE

A configurable DIY home automation, assistance and analytics project with IoT plugins.

---

George can aid you on automating your home.

George doesn't work out of the box! You need a server to run it on your local network and at least one IoT device.

Device	Support
ESP8266	In development

About

Server

• Node
• Typescript
• Express
• GraphQL
• Apollo Server
• TypeORM
• MQTT client (Mosca)
• Redis client

Client

• React
• Typescript
• Fluent UI Northstar
• SASS
• React Router
• Apollo Client
• Apollo in memory cache
• Apollo React Testing
• MobX
• React Testing Library
• Jest
• Webpack

Docs

• Docusaurus

Other services

• GraphQL codegen
• SQLite (optional for development mode)
• PostgreSQL
• Redis
• MQTT

Development directions ⌨️

1. Clone this project: git clone https://github.com/marcelovicentegc/george
2. Install its dependencies: npm i
3. If you already have docker or redis and postgres installed on your machine, jump to the next step, otherwise, install either Docker or Redis and Postgres before continuing
4. Make sure redis is up and running before starting this project (e.g. npm run start:redis or sudo service redis-server start or sudo systemctl start redis)
5. Make sure postgres is up and running before starting this project (e.g. npm run start:postgres or sudo service postgresl start or sudo systemctl start postgres)
6. By default, Redis runs on port 6379, the MQTT broker runs on port 1883, the server runs on port 4000, and the client on the port 3000. Check the configuration guide if you want to change some configuration.
7. You're good to go. Run: npm start
8. A default user will be created every time upon start. It has admin as username and password.
9. To generate new types, first change the types on src/server/schema/types/, run npm run gen while George is up and running, and add the query or mutation on src/gql/ files if necessary.

Pull requests 🌳

For pull requests, check the contribution guide

Production directions ⤴️

To put George in production, check the production instructions.