Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
firsttris committed Nov 28, 2023
1 parent d6aade2 commit d462e54
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,49 @@
# Motivation

Most Userinterfaces for Homematic are rather old and slow.
From a technical perspective many web based solutions are stuck with old commonJS code with callback hell of jquery and bootstraps.
Many Homematic user interfaces are outdated and sluggish.

My goal is to use modern Frontend-Technology the create a simple but blazing fast responsive web ui which you can install as an Addon on your ccu3 Homematic.
Technically, numerous web-based solutions are mired in antiquated commonJS code, entangled in the callback chaos of jQuery and Bootstrap.

Our aim is to leverage cutting-edge frontend technologies to craft a simple, yet lightning-fast, responsive web UI. This can be installed as an add-on to your CCU3, offering a seamless and dynamic user experience.

# Technology Stack

# Currently supported actors
This project is built with a robust set of technologies to ensure high performance and maintainability:

- [React](https://reactjs.org/): A JavaScript library for building user interfaces.
- [TypeScript](https://www.typescriptlang.org/): A strongly typed superset of JavaScript that adds static types.
- [Material-UI](https://mui.com/): A popular React UI framework for faster and easier web development.
- [React-Query](https://react-query.tanstack.com/): A data fetching library for React, used to fetch, cache and update data in your React and React Native applications.

# Efficiency

The App uses json-rpc in a combination with Rega Script to retrieve the data from the CCU in a more effiecient manner.

For this we've refined the Rega scripts available on Github,with the assistance of GitHub Copilot, tailoring them to fetch data in the exact structure required by our application.

In addition, we've utilized [React-Query](https://react-query.tanstack.com/) from TanStack, adhering to their best practices to ensure our data requests are as efficient as possible.

# Install

To install this add-on, download the tar.gz file from the releases page. You can then install it as a plugin on your CCU3. After installation, the add-on will be available at `http://ccu3ip/addons/mui`.

# Development and Build

To develop and build this project, follow these steps:

1. Clone the repository: `git clone https://github.com/homematic-mui5.git`
2. Navigate into the project directory: `cd homematic-mui5`
3. Install the dependencies: `npm install`
4. Start the development server: `npm start`
5. To build the project, use: `npm run build`

# Issues

Want to start contributing to this project?

Please visit our [issues page](https://github.com/your-repo-name/issues) for the latest features and issues.

# Currently supported devices

- [Light](/apps/homematic-mui5/src/app/LightControl.tsx)
- [Thermostat](/apps/homematic-mui5/src/app/ThermostatControl.tsx)
Expand Down

0 comments on commit d462e54

Please sign in to comment.