Skip to content

Latest commit

 

History

History
110 lines (85 loc) · 2.89 KB

README.md

File metadata and controls

110 lines (85 loc) · 2.89 KB

flask-robot-control-template

A simple and lightwight template to build an Internet of Things (IoT) application using Flask and MySQL. It also can be used to build a live RESTful API to deploy on raspberry pi.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Python
Virtual Environment
Your IDE

Resources

Check the followings to learn basic concepts about:

Installing

The final file structure for the .

iot-flask-template
├── app.py
├── devices.py
├── README.md
├── requirments.txt
├── templates
│   ├── about.html
│   ├── dashboard.html
│   ├── home.html
│   ├── includes
│   │   ├── _formhelpers.html
│   │   ├── _messages.html
│   │   └── _navbar.html
│   ├── layout.html

Follow the steps below to get a development env up and running in a ubuntu(linux).

  1. Go to your main project folder.
$ cd <path-to-the-folder>
  1. git clone the repository.
$ git clone git@github.com:cognitiveRobot/flask-robot-control-template.git
  1. Go inside the cloned folder.
$ cd flask-robot-control-template
  1. Create a Virtual Environment
$ python3 -m venv venv
  1. Activate the Virtual Environment
$ souce venv/bin/activate
  1. Upgrade the pip
$ pip install --upgrade pip
  1. Install all python packages
$ pip install -r requirments.txt
  1. If everything goes well up to now, then you would be able to quickly run the app.
$ python app.py

If all good so far, then follow next to know how to integrate the database for this app. If not, they raise an issue, I will reply asap.

Deployment

Comming soon.

Built With

Contributing

Make the pull request.

Versioning

For now please See the tags

Authors

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments