summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md33
1 files changed, 28 insertions, 5 deletions
diff --git a/README.md b/README.md
index 953ec69..c9f3e7f 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,18 @@
# Taler Merchant Demos Setup
*Warning: This page is not completed yet. Follow the instructions at your own risk*
## Installing the dependencies
+*Step 0 (Optional - Reccomended): Update Apt Repositories*
+> ```$ sudo apt update```
+
+<br/>
Step 1: `cd` into the directory:<br/>
> ```$ cd taler-merchant-demos```
<br/>
-Step 2: Ensure Python3.5 or above is installed using a command like:<br/>
+Step 2: Ensure Python 3.5 or above and Flask with the Babel extension are installed using a command like:<br/>
-> ```$ sudo apt install python3.8 -y```
+> ```$ sudo apt install python3.8 python3-flask-babel -y```
<br/>
Step 3: Ensure Python3 Pip is installed:<br/>
@@ -16,7 +20,7 @@ Step 3: Ensure Python3 Pip is installed:<br/>
> ```$ sudo apt install python3-pip -y```
<br/>
-Step 4: configure it using:<br/>
+Step 4: configure this package using:<br/>
> ```$ ./configure --destination=local```
@@ -27,14 +31,28 @@ Step 5: Install UWSGI<br>
<br/>
Step 6: Install LXML
-*NOTE: DO NOT INSTALL USING PIP2 (on my system, that is what the pip command uses) - INSTALL IT USING PIP3*
+*NOTE: DO NOT INSTALL USING PIP2 (on my system, that is what the pip command uses) - INSTALL IT USING PIP3*<br>
> ```$ pip3 install lxml```
+
+<br/>
+
+Step 7: Install NPM<br>
+
+> ```$ sudo apt install npm; sudo npm install -g npm node```
+
<br>
+Step 8: Install scss<br>
+> ```$ make sass-install```
+
+This will the NPM implementation of sass. If you have a Ruby
+tool called 'sass' installed, this build will NOT work.
+
+
## Quick Install for the dependencies
Here's one command to automatically install all dependencies at once:
-> ```$ sudo apt install python3.8 python3-pip -y; pip3 install lxml uwsgi; ./configure --destination=local```
+> ```$ sudo apt install python3.8 python3-pip npm -y; pip3 install lxml uwsgi; ./configure --destination=local; sudo npm install -g npm node;make sass-install```
## Configuring the demo
*This is just how I did it, and not the main method of doing it*
@@ -72,6 +90,11 @@ Step 3: Configure the config:
To apply changes, use
> ```$ make install```
+<br>
+
+To apply ***SCSS*** changes, use
+> ```$ make scss-build```
+
## Running the program
To start the server, use the following command:<br>
> ```$ taler-merchant-demos blog```