Updated Building (markdown)

Harvey Tindall 2020-07-16 19:09:33 +01:00
parent 3a4c720809
commit 2c91dc1064

@ -1,16 +1,16 @@
First, make sure you have poetry installed. See [here](https://python-poetry.org/docs/) for instructions. * First, make sure you have poetry installed. See [here](https://python-poetry.org/docs/) for instructions.
Then clone the repo. * Then clone the repo.
``` ```
hrfee@lab:~$ git clone https://github.com/hrfee/jellyfin-accounts.git hrfee@lab:~$ git clone https://github.com/hrfee/jellyfin-accounts.git
``` ```
Then enter the directory, grab python dependencies and enter the venv. * Then enter the directory, grab python dependencies and enter the venv.
``` ```
hrfee@lab:~$ cd jellyfin-accounts hrfee@lab:~$ cd jellyfin-accounts
hrfee@lab:~/jellyfin-accounts# poetry update hrfee@lab:~/jellyfin-accounts# poetry update
hrfee@lab:~/jellyfin-accounts# poetry shell hrfee@lab:~/jellyfin-accounts# poetry shell
``` ```
Next, you need to get bootstrap. jellyfin-accounts provides Bootstrap 4 and the v5 alpha, as well as a Jellyfin theme for each. The entire process can now be done with one command, but you will need to install [npm](https://www.npmjs.com/get-npm) first. * Next, you need to get bootstrap. jellyfin-accounts provides Bootstrap 4 and the v5 alpha, as well as a Jellyfin theme for each. The entire process can now be done with one command, but you will need to install [npm](https://www.npmjs.com/get-npm) first.
Once you have it, run Once you have it, run
``` ```
@ -21,7 +21,13 @@ This will install BS5, BS4, `clean-css`, `postcss`, and `autoprefixer`, the last
Once done, you should have `bs4.css, bs5.css, bs4-jf.css, bs5-jf.css` inside the `jellyfin_accounts/data/static/` directory. Once done, you should have `bs4.css, bs5.css, bs4-jf.css, bs5-jf.css` inside the `jellyfin_accounts/data/static/` directory.
Finally, you can build and install: * The last step before building is to generate the html files for emails. This can be done by running
```
hrfee@lab:~/jellyfin-accounts# poetry run task generate-emails
```
This copies the html and txt email files into `jellyfin_accounts/data/`.
* Finally, you can build and install:
``` ```
hrfee@lab:~/jellyfin-accounts# poetry build hrfee@lab:~/jellyfin-accounts# poetry build
hrfee@lab:~/jellyfin-accounts# poetry install hrfee@lab:~/jellyfin-accounts# poetry install