Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
MarcinOrlowski committed Oct 6, 2024
1 parent 12a4aff commit 94ca024
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions docs/dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
# Dev corner

[« Back to main menu](README.md)

1. [Profiles](#profiles)
2. [Building the package](#building-the-package)

Expand All @@ -21,65 +22,66 @@ directory:

Windows

```
%USERPROFILE%\AppData\Local\MarcinOrlowski\WebsiteAsApp\<APP_PROFILE_NAME>\
```
```ascii
%USERPROFILE%\AppData\Local\MarcinOrlowski\WebsiteAsApp\<APP_PROFILE_NAME>\
```

Linux

```
~/.local/share/MarcinOrlowski/WebsiteAsApp/<APP_PROFILE_NAME>/
```
```ascii
~/.local/share/MarcinOrlowski/WebsiteAsApp/<APP_PROFILE_NAME>/
```

MacOS

```
??? (PLEASE ASSIST)
```
```ascii
??? (PLEASE ASSIST)
```

---

## Building the package

1. Checkout the source code:
Checkout the source code:

```bash
$ cd <DIR>
$ git clone ....
$ cd website-as-app
```

2. Setup its runtime environment (NOTE: if you are using different shell than `bash` (i.e. `fish`),
please use correct `activate` script from `venv/bin/` directory):
Setup its runtime environment (NOTE: if you are using different shell than `bash` (i.e. `fish`),
please use correct `activate` script from `venv/bin/` directory):

```bash
$ python -m venv venv
$ source venv/bin/activate # User right one for your shell
```

3. Install all the dependencies:
Install all the dependencies:

```bash
(venv) $ pip install -r requirements-dev.txt
```

4. Build the package:
Build the package:

```bash
(venv) $ python -m build
```

5. Install package locally for testing.
We intentionally ignore `install --upgrade` while planting new build, as we need to ensure no
cached bytecode from previous version remains (which could be the case as we do not increment the
version each build).
Install package locally for testing.

We intentionally ignore `install --upgrade` while planting new build, as we need to ensure no
cached bytecode from previous version remains (which could be the case as we do not increment the
version each build).

```bash
(venv) $ pip uninstall --yes dist/website_as_app-1.0.0-py3-none-any.whl
(venv) $ pip install dist/website_as_app-1.0.0-py3-none-any.whl
```

6. Test the app
Test the app

```bash
(venv) $ webapp -h
Expand Down

0 comments on commit 94ca024

Please sign in to comment.