Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wizand0/flask_web_for_arduino


https://github.com/wizand0/flask_web_for_arduino

Last synced: about 1 month ago
JSON representation

Awesome Lists containing this project

README

        

# TODO App

### It is a backend for arduino project: https://github.com/wizand0/DC_Monitor_UNO

#### This is an Introduction to flask. This repo contains a simple web app (TODO) and log for sensors based
#### on arduino uno using flask to get started in flask.
#### ะจn case of emergency, sends a message to a telegram bot

For testing

## TODO:
- Work with email;
- Work with telegram bot

### ๐Ÿ“ Table of Contents

- [About](#about)
- [Getting Started](#getting_started)
- [Installation](#installation)
- [Built Using](#built_using)

### ๐Ÿง About

Flask is a micro web framework written in Python. It is classified as a microframework because it does not require particular tools or libraries.
In this Repo, we will be creating a simple web app (TODO Master).

### ๐Ÿ Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

The project requires

- python 3.8 or higher. You can download python from [here](https://www.python.org/downloads/)
- pip. You can download pip from [here](https://pip.pypa.io/en/stable/installing/)
- virtualenv. You can download virtualenv from [here](https://virtualenv.pypa.io/en/latest/installation.html)

### Installation

Installing the project is very simple. Just follow the steps below

1. Clone the repo

```
git clone
```

2. Create a virtual environment

```
virtualenv venv
```

3. Activate the virtual environment

```
source venv/bin/activate
```

4. Install the requirements

```
pip install -r requirements.txt
```

5. Run the app

```
python app.py
```

6. Open the app in your browser

```
http://localhost:5000
```

### โ›๏ธ Built Using

- [Flask](https://flask.palletsprojects.com/en/1.1.x/) - Web Framework
- [Python](https://www.python.org/) - Programming Language
- SQL-ALchemy
- Telegram api

### Changelog
v. 1.0.5. - added login and registration pages. Now only registered user can view and edit data.
v. 1.0.4. - minor fixes for stability.
v. 1.0.0. - functionality for sending telegram messages.
v. 0.8.0 - logging functionality.