https://github.com/tafkas/belka-flask
A web application controlling the DiddiBorg V2
https://github.com/tafkas/belka-flask
diddyborg flask
Last synced: 2 months ago
JSON representation
A web application controlling the DiddiBorg V2
- Host: GitHub
- URL: https://github.com/tafkas/belka-flask
- Owner: Tafkas
- Created: 2018-01-19T13:51:59.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-23T15:35:54.000Z (about 7 years ago)
- Last Synced: 2025-01-30T21:57:43.020Z (4 months ago)
- Topics: diddyborg, flask
- Language: CSS
- Size: 223 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Belka Flask
Belka Flask is a web application controlling the [DiddiBorg V2](https://www.piborg.org/robots/diddyborg-v2) roboter.
## Quick Start
Run the application:
make run
And open it in the browser at [http://127.0.0.1:5000/](http://127.0.0.1:5000/)
## Prerequisites
This is built to be used with Python 3. Update `Makefile` to switch to Python 2 if needed.
Some Flask dependencies are compiled during installation, so `gcc` and Python header files need to be present.
For example, on Ubuntu:
apt install build-essential python3-dev
## Development environment and release process
- create virtualenv with Flask and Belka Flask installed into it (latter is installed in
[develop mode](http://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode) which allows
modifying source code directly without a need to re-install the app): `make venv`
- run development server in debug mode: `make run`; Flask will restart if source code is modified
- run tests: `make test` (see also: [Testing Flask Applications](http://flask.pocoo.org/docs/0.12/testing/))
- create source distribution: `make sdist` (will run tests first)
- to remove virtualenv and built distributions: `make clean`
- to add more python dependencies: add to `install_requires` in `setup.py`
- to modify configuration in development environment: edit file `settings.cfg`; this is a local configuration file
and it is *ignored* by Git - make sure to put a proper configuration file to a production environment when
deploying
## Deployment
tba