# quixote

This is a web application that allows you track your reading habits.

## Usage

The following environment variables should be set before you run the app:

- `QUIXOTE_USR_DIR` which should point to the directory that `static/` has been copied to (which contains the CSS theme)
- `QUIXOTE_VAR_DIR` which is where the `quixote.db` will be stored in
- `QUIXOTE_ADDRESS` to chose which IP to bind to (e.g. `127.0.0.1`, `::1`, `0.0.0.0`, `::`)
- `QUIXOTE_PORT` to chose which port to bind to (e.g. `5000`)

```bash
QUIXOTE_USR_DIR=... QUIXOTE_VAR_DIR=... ./quixote
```

The application will run on port 5000.

## Build

To build the application run the following command:

```bash
make
```

## Test

```bash
make all
```

## Design Considerations

- Optimize for single user on a local network
  - There is no authentication
  - Only run on a trusted local network
- Optimize for local data control
  - Use a sqlite database
