coriplus/README.md

35 lines
792 B
Markdown
Raw Permalink 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/).
2019-11-11 19:15:55 +01:00
This is the server. For the client, see [coriplusapp](https://github.com/sakuragasaki46/coriplusapp/).
2019-10-09 21:08:10 +02:00
## 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
* SQLite (or PostgreSQL)-based app
2019-10-11 12:20:40 +02:00
## Requirements
* **Python 3.10+** with **pip**.
* **Flask** web framework.
2019-10-11 12:20:40 +02:00
* **Peewee** ORM.
* A \*nix-based OS.
## Installation
* Install dependencies: `pip install .`
* Set the `DATABASE_URL` (must be SQLite or PostgreSQL)
* Run the migrations: `sh ./genmig.sh @`
* i forgor