coriplus/README.md

24 lines
550 B
Markdown
Raw Normal View History

2019-10-09 21:08:10 +02:00
# Cori+
A simple social network, inspired by the now dead Google-Plus.
2019-05-01 15:38:00 +02:00
2019-10-27 11:30:14 +01:00
To run the app, do "flask run" in the package's parent directory.
2019-05-01 15:38:00 +02:00
2019-10-09 21:08:10 +02:00
Based on Tweepee example of [peewee](https://github.com/coleifer/peewee/).
## Features
* Create text statuses, optionally with image
* Follow users
* Timeline feed
2019-10-20 20:19:20 +02:00
* Add info to your profile
2019-10-09 21:08:10 +02:00
* In-site notifications
2019-10-27 11:30:14 +01:00
* Public API
2019-10-09 21:08:10 +02:00
* SQLite-based app
2019-10-11 12:20:40 +02:00
## Requirements
* **Python 3** only. We don't want to support Python 2.
2019-10-12 19:22:10 +02:00
* **Flask** web framework (also required extension **Flask-Login**).
2019-10-11 12:20:40 +02:00
* **Peewee** ORM.