summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2022-09-24 17:06:26 +0200
committerChristian Grothoff <christian@grothoff.org>2022-09-24 17:06:26 +0200
commitd80c9fe69b35cf47bfd13b628c379c55d468c6fc (patch)
tree18cc35268a6e67ca7dcae4ec7039de4f5eea4b9c /README.md
parent22c3bfee9148e1836817ef00b4829a8385570c69 (diff)
downloadtaler-merchant-demos-d80c9fe69b35cf47bfd13b628c379c55d468c6fc.tar.gz
taler-merchant-demos-d80c9fe69b35cf47bfd13b628c379c55d468c6fc.tar.bz2
taler-merchant-demos-d80c9fe69b35cf47bfd13b628c379c55d468c6fc.zip
Nora CSS and build system updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md138
1 files changed, 76 insertions, 62 deletions
diff --git a/README.md b/README.md
index eebbbdb..ac313e2 100644
--- a/README.md
+++ b/README.md
@@ -1,103 +1,116 @@
# 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 Python 3.5 or above and Flask with the Babel extension are installed using a command like:<br/>
-
-> ```$ sudo apt install python3.8 python3-flask-babel -y```
-
-<br/>
-Step 3: Ensure Python3 Pip is installed:<br/>
-
-> ```$ sudo apt install python3-pip -y```
-
-<br/>
-Step 4: configure this package using:<br/>
-
-> ```$ ./configure --destination=local```
-
-Step 5: Install UWSGI<br>
-*NOTE: DO NOT INSTALL USING PIP2 (on my system, that is what the pip command uses) - INSTALL IT USING PIP3*
-> ```$ pip3 install uwsgi```
+_Warning: This page is not completed yet. Follow the instructions at your own risk_
-<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*<br>
-
-> ```$ pip3 install lxml```
-
-<br/>
-
-Step 7: Install NPM<br>
+## Installing the dependencies
-> ```$ sudo apt install npm; sudo npm install -g npm node sass```
+### Automatically
-<br>
+The [Makefile](./Makefile) contains premade scripts for some distros;
-This will the NPM implementation of sass. If you have a Ruby
-tool called 'sass' installed, this build will NOT work.
+```bash
+# Arch-based (Manjaro, Arco, etc...)
+$ make setup-arch
+# Debian-based (Ubuntu, Mint, etc...)
+$ make setup-deb
+```
-## Quick Install for the dependencies
-Here's one command to automatically install all dependencies at once:
-> ```$ 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```
+### Manually
+
+<!--
+ TODO: Migrate to per-distro instructions
+ -> We need to consider if we should incrase the README.md's size, or if we should split said per-distro instructions into multiple files
+-->
+
+_Note: These instructions assume you are on a debian-based distribution. Other distributions may vary!_
+
+1. Update Apt Repositories (Recommended);
+ > ```bash
+ > $ sudo apt update
+ > ```
+2. Step 2: Ensure Python 3.5 or above and Flask with the Babel extension are installed;
+ > ```bash
+ > $ sudo apt install python3 python-is-python3 python3-flask-babel -y
+ > ```
+3. Ensure Python3 Pip is installed;
+ > ```bash
+ > # you may need to use python3-pip on some systems
+ > $ sudo apt install python3-pip -y
+ > ```
+4. Configure things using:
+ > ```bash
+ > $ ./configure --destination=local
+ > ```
+5. Install UWSGI
+ > ```bash
+ > $ pip install uwsgi # You may need to use pip3 on some systems
+ > ```
+6. Install LXML
+ > ```bash
+ > $ pip install lxml # You may need to use pip3 on some systems
+ > ```
+7. Install NodeJS <!-- NOTE: Likely redundant, legacy -->
+ > ```bash
+ > $ sudo apt install npm nodejs
+ > ```
+8. Install Poetry
+ > ```bash
+ > $ pip install poetry
+ > ```
## Configuring the demo
-*This is just how I did it, and not the main method of doing it*
+
+_This is just how I did it, and not necessarily the optimal method. You should only use this in testing._
Step 1: Open the config:
-> ```$ editor ~/.config/taler.conf```
-<br>
+> `$ editor ~/.config/taler.conf` > <br>
-Step 2: Adding the required keys:
-> Copy & Paste the following into the file:
+Step 2: Adding the required configuration values:
> ```
> [frontends]
-> backend_apikey = "ApiKey Sandbox"
-> backend = https://backend.test.taler.net/
+> backend_apikey = "secret-token:secret"
+> backend = https://backend.demo.taler.net/
>
> [taler]
-> currency = TESTKUDOS
+> currency = KUDOS
>
> [blog]
> http_port = 8080
> serve = http
-```
+> ```
+
<br>
Step 3: Configure the config:
+
> 1. Replace the backend api key with the api key for the backend<br>
> 2. Replace the backend URL with the actual backend link<br>
-> 3. Replace the http port with the port<br>
-> 4. (Optional: Replace the currency with your currency)
+> 3. Replace the http port with whichever port you desire<br>
+> 4. _In Production:_ Replace the currency with your currency
+
<br>
## Applying Changes
-To apply changes, use
-> ```$ make install```
-<br>
+To apply changes, use
-To apply ***SCSS*** changes, use
-> ```$ make scss-build```
+> `$ make install`
## Running the program
+
To start the server, use the following command:<br>
-> ```$ taler-merchant-demos blog```
+
+> `$ taler-merchant-demos blog`
+
+_Note: If zsh asks you if you want to correct it to talermerchantdemos, select **no**_
## More configuration options.
+
This makes the blog speak UWSGI over TCP:
+
> ```
> [frontends]
> backend_apikey = "ApiKey Sandbox"
@@ -110,11 +123,12 @@ This makes the blog speak UWSGI over TCP:
> serve = uwsgi
> uwsgi_serve = tcp
> uwsgi_port = XZY
-
> ```
+
<br>
This makes the blog speak UWSGI over unix domain socket:
+
> ```
> [frontends]
> backend_apikey = "ApiKey Sandbox"