summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSanna-Kaisa T Sievi-Korte <ssieviko@local>2023-12-12 01:35:03 +0200
committerSanna-Kaisa T Sievi-Korte <ssieviko@local>2023-12-12 01:35:03 +0200
commit3dc9e71b7c733e7fe6fe9e226ad363f84a2e1dee (patch)
tree76e8ae31ae99af76bcb8265ad9844ff7c154972f
parent7e1d8ed814e77d83aa0be0d69bf7833eb3c83a57 (diff)
Making README.md more readable.
-rw-r--r--README.md32
1 files changed, 16 insertions, 16 deletions
diff --git a/README.md b/README.md
index c070c76..5f32a58 100644
--- a/README.md
+++ b/README.md
@@ -3,42 +3,42 @@
## TO GET IT RUNNING:
-#### Install postgresql for local user & get it running (as in course material)
-- $ wget https://github.com/hy-tsoha/local-pg/raw/master/pg-install.sh
-- $ bash pg-install.sh
-- $ postrgres &
+#### Install postgresql for local user & get it running [as in course material](https://hy-tsoha.github.io/materiaali/osa-2/)
+- `wget https://github.com/hy-tsoha/local-pg/raw/master/pg-install.sh`
+- `bash pg-install.sh`
+- `postrgres &`
#### Clone the source
-- $ git clone https://github.com/triionhe/kyselma.git
-- $ cd kyselma
+- `git clone https://github.com/triionhe/kyselma`
+- `cd kyselma`
#### Get database ready
-- $ psql < SCHEMA.sql (BE CAREFUL! This drops some tables.)
+- `psql < SCHEMA.sql` (BE CAREFUL! This drops some tables.)
#### Either use (1) poetry or (2) venv to handle dependencies and run the app
(1) Install poetry if nessesary. (refer your distro)
-- $ pip install --user poetry
-- $ pipx install poetry
+- `pip install --user poetry`
+- `pipx install poetry`
(1) Install dependencies
-- $ PYTHON_KEYRING_BACKEND=keyring.backends.fail.Keyring poetry install --no-root
+- `PYTHON_KEYRING_BACKEND=keyring.backends.fail.Keyring poetry install --no-root`
(1) Start the app in poetry virtual environment
-- $ poetry run flask run
+- `poetry run flask run`
(2) Activate venv environment
-- $ python3 -m venv venv
-- $ source venv/bin/activate
+- `python3 -m venv venv`
+- `source venv/bin/activate`
(2) Install dependencies with pip
-- $ pip install -r ./requirements.txt
+- `pip install -r ./requirements.txt`
(2) Start the app
-- $ flask run
+- `flask run`
#### Surf to the webpage
-- $ firefox http://127.0.0.1:5000/
+- `firefox http://127.0.0.1:5000/`
There is ready made kyselmä named 'kysdemo' for testing.