/DoMZX

home automation

Primary LanguageJavaScriptMIT LicenseMIT


DoMZX

Home automation

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Contributing
  5. License
  6. Contact

About The Project

DoMZX is a comprehensive home automation project that covers everything from development to deployment, offering complete control over your home's various systems. Using a Raspberry Pi as the central hub, DoMZX includes functionalities such as a pool timer, shutter controls, and door automation. The project is built using Flask for the backend and React for the frontend, providing a seamless user experience. With DoMZX, users can effortlessly manage and customize their home automation setup, bringing convenience and efficiency to everyday living.

(back to top)

Built With

  • Flask
  • Python
  • Vite
  • React
  • Raspberry Pi

(back to top)

Screenshots

Home Timer Logs Settings

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

The project is designed with python3 and npm so make sure to have it installed

  • python 
    python3 --version
  • node 
    npm --version

Installation

  1. Clone the repo 
    git clone https://github.com/StanislasMzx/DoMZX.git
  2. Install requirements 
    python3 -m pip install -r requirements.txt
  3. Migrate de DB 
    flask init-db
  4. Setup frontend 
    cd frontend
npm i

(back to top)

Usage

Backend

python3 app.py

Frontend

cd frontend
npm run dev

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/StanislasMzx/DoMZX

(back to top)