# Thechart
App to manage medication and see the evolution of its effects.

## Installation

### Install dev environment and dependencies
The Makefile is set to use the fish shell by default, see the section on [`bash/zsh/csh`](#bash/zsh/csh). The environment will be activated as well, therefore the next section can be skiped, and you can jump to [`run the app`](#Run%20the%20app).
```shell
make install
```

### Activate the environment according to your shell

#### bash/zsh/csh
```shell
eval $(poetry env activate)
```

#### fish
```shell
eval (poetry env activate)
```
or
```shell
make shell
```

## Run the app
```shell
make run
```

## Build container image
```shell
make build
```

## Run unit tests
```shell
make test
```

## Deploy the app
### Linux / Unix
The app will be deployed in **~/Applications**, the CSV data file *thechart_data.csv* will be store in **~/Documents**.
```shell
make deploy
```
### MacOS / Windows
TODO: use OS specific flags with *pyinstaller*.

## Make options
Show the help menu:
```shell
make help
```
Sub-commands listed below:
```
attach               Open a shell in the container
build                Build the Docker image
deploy               Deploy standalone app executable
format               Format the code
help                 Show this help
install              Set up the development environment
lint                 Run the linter
requirements         Export the requirements to a file
run                  Run the application
shell                Open a shell in the local environment
start                Start the app
stop                 Stop the app
test                 Run the tests
```