From e171ab62476cf315f7b4caad4104c81692fca4c0 Mon Sep 17 00:00:00 2001 From: Alex Date: Tue, 30 Nov 2021 22:22:28 +0100 Subject: [PATCH] new requirements --- README.md | 60 ++++++++++++++++--------------------------------------- 1 file changed, 17 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index f5374dd..33fb199 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,14 @@ -# XPUB Library -Library running on Flask and SQLight (maybe to be replaced with a python shelve) +# XPPL version alt +Library to hold books / knowledge + +## TO DOs +[*] fix adding stacks +[*] update requirements +[ ] generate new requirements.txt and installation process? +[ ] fix stacks layout +[ ] remove autocomplete? and training at the start of app +[ ] update layout navigation + ## Installation @@ -8,68 +17,33 @@ Install the required dependencies: $ pip3 install -r requirements.txt -Initialise database +Initialise database / Why is this needed again, could be checked in flask? $ bash init_db.sh -### Install rqlite - -#### Linux -To download and start rqlite on Linux, execute the following in a shell. - - curl -L https://github.com/rqlite/rqlite/releases/download/v4.3.0/rqlite-v4.3.0-linux-amd64.tar.gz -o rqlite-v4.3.0-linux-amd64.tar.gz - tar xvfz rqlite-v4.3.0-linux-amd64.tar.gz - cd rqlite-v4.3.0-linux-amd64 - ./rqlited ~/node.1 - - -#### OSX -To download and start rqlite on OSX, execute the following in a shell. - -curl -L https://github.com/rqlite/rqlite/releases/download/v4.3.0/rqlite-v4.3.0-darwin-amd64.tar.gz -o rqlite-v4.3.0-darwin-amd64.tar.gz -tar xvfz rqlite-v4.3.0-darwin-amd64.tar.gz -cd rqlite-v4.3.0-darwin-amd64 -./rqlited ~/node.1 - - - - ### Further install notes (bugs) * create the covers folder inside the uploadsfolder * don't forget to chmod the uploads and coverfolder ;-) -* For Mac users -> brew install imagemagick@6 in order to install wand - -For those on mac and using homebrew, it seems like Wand doesn't support imagemagick 7 yet as mentioned in other answers. -There's a new brew formula for Imagemagick 6 which can be used to install the older version in the meanwhile: -`brew install imagemagick@6` - -Create a symlink to this newly installed dylib file as mentioned in other answer to get things working. - - ln -s /usr/local/Cellar/imagemagick@6//lib/libMagickWand-6.Q16.dylib /usr/local/lib/libMagickWand.dylib - - - - +* For Mac users -> brew install imagemagick@6 in order to install wand (should not be relevant for debian server install) ## Run the program -Initialize rqlite database on one terminal (from rqlite install directory) - - $ ./rqlited ~.node - Run the script in another terminal (from XPPL directory): python3 run.py +## Deploy on server + +(this will be added soon) -## API +## REST API Has currently 2 entrypoints: