Skip to content

Commit

Permalink
Merge pull request #1123 from mild-blue/1092_installation_description…
Browse files Browse the repository at this point in the history
…_in_readme_doesn't_have_a_

Installation description in README doesn't have a lot of small details
  • Loading branch information
krllstdn authored Feb 3, 2023
2 parents 0ad4eb2 + 738b491 commit 2020c19
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ try to remove `node_modules` folder from `txmatching/web/frontend/`, run `npm ca
Backend is written in Python. We are using [conda](https://docs.conda.io/en/latest/miniconda.html) for
dependency management. To be able to run the project you must have it installed.

If you are using macOS on an ARM-based computer, make sure that you install anaconda for x86_64 architecture using rosetta.
(Some packages still are not built for ARM).

After you have conda ready and setup. Execute `make conda-create` which creates Conda env for you.

Finally, activate the environment with `conda activate txmatching`
Expand All @@ -44,12 +47,30 @@ Finally, activate the environment with `conda activate txmatching`

For pdf generation, a [wkhtmltopdf](https://wkhtmltopdf.org/downloads.html) is required to be installed.

##### macOS
In macOS it can be installed via brew:
```
brew install wkhtmltopdf
```

##### Linux and WSL
With linux it is a bit more complicated:
```
sudo apt update
sudo apt install wget xfonts-75dpi
cd /tmp
```

Also, you may need to install `libssl1.1.1` because newer versions
of Ubuntu (e.g. 22.04 LTS) use a newer version of libssl, which is not compatible with wkhtmltopdf.

```
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl-dev_1.1.1f-1ubuntu2.16_amd64.deb
wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2.16_amd64.deb
sudo dpkg -i libssl-dev_1.1.1f-1ubuntu2.16_amd64.deb
sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2.16_amd64.deb
```

`wget https://github.com/wkhtmltopdf/packaging/releases/download/0.12.6-1/wkhtmltox_0.12.6-1.focal_amd64.deb` (choose your version)

`sudo dpkg -i wkhtmltox_0.12.6-1.focal_amd64.deb` (of the correct version that you want to install)
Expand Down
8 changes: 8 additions & 0 deletions txmatching/web/frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ and then:
npm -v
```

Make sure Node.js is of the latest versions (preferably 18.0+).

### Angular

In Terminal or Command line run:
Expand All @@ -41,6 +43,8 @@ In Terminal or Command line run:
npm install -g @angular/cli
```

(In Ubuntu based system you may need to run it with superuser rights)

It will globally install Angular on your machine.

### OpenAPI Generator
Expand All @@ -51,6 +55,10 @@ We use _openapi-generator_ to automatically generate TS files from swagger. Plea
npm install -g @openapitools/openapi-generator-cli
```

(In Ubuntu based system you may need to run it with superuser rights)

Also make sure that you have Java installed on your machine, as it is required by _openapi-generator_.

---

Note: Navigate to `txmatching/web/frontend` before running the commands bellow.
Expand Down

0 comments on commit 2020c19

Please sign in to comment.