Fez

A LAN chat app, built with python3 and flask.

Branches

• master: for stable versions only.

• rewrite: for the rewrite (see projects)

Installation

Dependencies (for this branch)

• Python 3

  • choose the latest version of Python 3. Fez should work on a minimum of 3.5.2.

• Flask

  • $ pip install flask

• Flask-RESTPlus

  • $ pip install flask-restplus

• python-dotenv

  • $ pip install python-dotenv

• markdown

  • $ pip install markdown

• Please ensure you have all dependencies installed, before attempting to use fez.

• Please note that this project was tested on a Raspberry Pi, but it should work on any platform with these dependencies installed.

Download

• $ git clone https://www.github.com/Adoria298/flask-messenger.git

Usage

• Change directory into the cloned directory (usually flask-messenger)

• $ python3 -m flask run

For Production

• open .flaskenv in a text editor of your choice,

  • change FLASK_ENV to production.

  • change FLASK_DEBUG to 0.

• run on a production server, following official guidelines.

For Development

• By default, a newly cloned installation is set up by default for flask development. If you want to contribute, please look at the roadmap for features, or the bug triage project for bugs you might be able to fix. If there are any other projects open, look at features you could implement.

• API docs can be found in a running installation at /api .

Meta

License

Fez is licensed under the GNU GPL v3 license. For more information, please see LICENSE.

Acknowledgements

• The Raspberry Pi people for their "Build a Python Web Server With Flask" project, and for the Raspberry Pi itself.

Versioning

Fez uses Semantic Versioning

Roadmap

• Add a CLI messaging utitity.

• Improve the UI of the frontend web app.

• Release v1.0