From d93bfa4428b67def3cad04e5cb0d940f8eeebc2f Mon Sep 17 00:00:00 2001 From: coolneng Date: Fri, 10 Jan 2020 12:20:32 +0100 Subject: [PATCH] Fit screenshot to page --- Design.org | 7 ++++--- README.org | 23 ++++++++++++----------- 2 files changed, 16 insertions(+), 14 deletions(-) diff --git a/Design.org b/Design.org index 33dd57f..ab94349 100644 --- a/Design.org +++ b/Design.org @@ -65,11 +65,12 @@ CLOSED: [2020-01-09 Thu 20:57] - [X] Text search for glaciers - [X] Form seach for a year *** TODO Documentation [1/3] [33%] +- [X] Readme - [ ] Code - [ ] Explanations (uid as Varchar, technologies used) -- [X] Readme -*** TODO Deployment [0/1] [0%] -- [ ] Virtualenv installation script +*** DONE Deployment [1/1] [100%] +CLOSED: [2020-01-10 Fri 12:14] +- [X] Installation instructions *** DONE Frontend [2/2] [100%] CLOSED: [2020-01-09 Thu 11:09] - [X] Flask-Bootstrap diff --git a/README.org b/README.org index d84f05f..431477e 100644 --- a/README.org +++ b/README.org @@ -7,6 +7,7 @@ Web UI. #+CAPTION: Table +#+ATTR_HTML: :width 120 [[./assets/screenshots/Table.png]] ** Technologies used @@ -26,21 +27,21 @@ Web UI. 1. Clone the repository: - #+BEGIN_SRC sh +#+BEGIN_SRC sh git clone https://coolneng.duckdns.org/gitea/coolneng/igdb - #+END_SRC +#+END_SRC 2. Change the working directory to the project: - #+BEGIN_SRC sh +#+BEGIN_SRC sh cd igdb - #+END_SRC +#+END_SRC 3. Install the dependencies: - #+BEGIN_SRC sh +#+BEGIN_SRC sh pipenv install - #+END_SRC +#+END_SRC All the dependencies will be installed inside a virtualenv. @@ -49,15 +50,15 @@ All the dependencies will be installed inside a virtualenv. 1. Start a shell inside the virtualenv: - #+BEGIN_SRC sh +#+BEGIN_SRC sh pipenv sh - #+END_SRC +#+END_SRC 2. Start the Flask server: - #+BEGIN_SRC sh +#+BEGIN_SRC sh flask run - #+END_SRC +#+END_SRC 3. When prompted for a password, insert your MySQL/MariaDB root password @@ -65,4 +66,4 @@ The database will be created and populated automatically, if needed, each time t 3. The website can be accessed via the URL: -localhost:5000 +- localhost:5000