23 lines
1.0 KiB
Markdown
23 lines
1.0 KiB
Markdown
# Simple Grocery List (Sigl)
|
|
|
|
Simple Grocery List, or **Sigl** (pronounced "sigil") is a lightweight shopping list manager designed for shared grocery lists (or any other shopping list). Sigl is designed to be intuitive and flexible, emphasizing an ad-hoc approach to shopping lists rather than "recipe" based lists.
|
|
|
|
## Quick Start
|
|
|
|
Install [Docker](https://www.docker.com/) and
|
|
[Docker Compose](https://docs.docker.com/compose/install/) for your platform.
|
|
Then run the following commands to clone the Jade Tree repository and run a
|
|
local instance of Jade Tree on your machine. Note that the database migration
|
|
only has to be done once to set up a fresh database or to upgrade a database to
|
|
the latest schema.
|
|
|
|
```sh
|
|
$ git clone https://github.com/asymworks/sigl.git sigl
|
|
$ docker-compose -f sigl/docker-compose.yaml up -d
|
|
$ docker-compose -f sigl/docker-compose.yaml \
|
|
exec app /home/sigl/docker-entry.sh db upgrade
|
|
$ docker-compose -f sigl/docker-compose.yaml restart app
|
|
```
|
|
|
|
Then access the Sigl server at http://localhost:5151
|