aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCédric Bonhomme <cedric@cedricbonhomme.org>2020-04-06 23:05:31 +0200
committerCédric Bonhomme <cedric@cedricbonhomme.org>2020-04-06 23:05:31 +0200
commit49b199c610bb32d0581d771d856b3e3332707f17 (patch)
tree9e9c633d5d77bf3ae56395d8cd732ce20dba6b43 /README.md
parentAdded a link to the documentation in the about page. (diff)
downloadnewspipe-49b199c610bb32d0581d771d856b3e3332707f17.tar.gz
newspipe-49b199c610bb32d0581d771d856b3e3332707f17.tar.bz2
newspipe-49b199c610bb32d0581d771d856b3e3332707f17.zip
Migrate form Flask-Script to the built-in integration of the click command line interface of Flask.
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.md b/README.md
index bdc92fd5..91cf7922 100644
--- a/README.md
+++ b/README.md
@@ -51,13 +51,21 @@ $ git clone https://git.sr.ht/~cedric/newspipe
$ cd newspipe/
$ npm install
$ poetry install
-$ export Newspipe_CONFIG=sqlite.py
$ poetry shell
$ pybabel compile -d newspipe/translations
-$ python manager.py db_create
-$ python manager.py create_admin <nickname> <password>
-$ python runserver.py
- * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
+$ export NEWSPIPE_CONFIG=sqlite.py
+$ export FLASK_APP=runserver.py
+$ export FLASK_ENV=development
+$ flask db_create
+$ flask create_admin --nickname <nickname> --password <password>
+$ flask run
+ * Serving Flask app "runserver" (lazy loading)
+ * Environment: development
+ * Debug mode: on
+ * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
+ * Restarting with stat
+ * Debugger is active!
+ * Debugger PIN: 221-873-938
```
If you want to use PostgreSQL you can customize
@@ -67,7 +75,7 @@ the provided example configuration file (``instance/config.py``):
$ sudo apt-get install postgresql
$ cp instance/config.py instance/postgresql.py
$ vim instance/postgresql.py # customize it
-$ export Newspipe_CONFIG=postgresql.py
+$ export NEWSPIPE_CONFIG=postgresql.py
```
For production you can use [Gunicorn](https://gunicorn.org) or ``mod_wsgi``.
bgstack15