From 2bd355130d49ca5f838704dd9841ea7783b35d69 Mon Sep 17 00:00:00 2001 From: crunk Date: Sun, 9 Jan 2022 13:24:16 +0100 Subject: [PATCH] updated README.md to current project status --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fd0d347..9d01939 100644 --- a/README.md +++ b/README.md @@ -25,11 +25,33 @@ $ pip install -r requirements.txt ## Database, Databass The git doesn't come with a database of users, you have to make one. -make sure you have the virtual environment enabled. +make sure you have the virtual environment enabled. the data directory is in +gitignore because we don't want to version control the database and other files +that might end up there later. ``` +$ cd verse +$ mkdir data +``` +You might need to remove the migrations folder, this is where flask-migrate keeps +track of all the database upgrades and migrations. but so far we have none and +for deploydb to work this folder needs to not be there yet. +``` +$ rm -r migrations $ python deploydb.py ``` +Database is made and put in the data folder. ready to go + +## Flask scripts +The flask scripts are in the folder verse, while the distribusi code is in the +folder distribusi, I would like to keep them separated so we know, what is the +webapplication and what is the original distribusi software, this might also +allow power users with SSH later on. + +``` +$ cd verse +$ python start.py +``` ## Distribusi This is currently added as a git submodule but I have no clue how that actually works