Octo-Tree

This project is a web application that interfaces with an Arduino Uno board to monitor and control various sensors and actuators. The backend is built with Typescript, using Express for the web framework, Socket.io for real-time communication, and SQLite for data storage. The frontend is developed with TypeScript, React, Socket.io, and TailwindCSS.

Octo-Tree

Features

Real-time data visualization from Arduino sensors.
Control actuators connected to the Arduino from the web app.
Store and retrieve sensor data using SQLite.
Responsive and modern UI with React and TailwindCSS.

Hardware Requirements

Arduino Uno board
USB cable for Arduino
Various sensors (e.g., temperature, humidity, light, etc.)
Actuators (e.g., LEDs, relays, motors, etc.)
Breadboard and jumper wires

Software Requirements

Python 3.x
Node.js and npm
Arduino IDE

Installation

Backend Setup

Clone the repository:

git clone https://github.com/asterki/octo-tree.git
cd octo-tree

Navigate to the server directory:
```
cd server
```
Set up the server and install dependencies:
```
npm i
```
Run the Flask server:
```
npm run dev
```

Frontend Setup

Navigate to the frontend directory and install dependencies:
```
cd client
npm install
```
Start the development server:
```
npm run dev
```

Arduino Setup

Open the Arduino IDE and upload the provided sketch (arduino/index.ino) to your Arduino Uno board.
Ensure the correct serial port is selected.

Usage

Ensure the Node backend and React frontend servers are running.
Open your web browser and navigate to http://localhost:5173.
You should see the web app interface where you can monitor sensor data and control actuators.

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes. Ensure your code adheres to the project's coding standards and include appropriate tests.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Asterki / octo-tree

readme