Skip to content

Commit

Permalink
Add init-db note in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
scossu committed Sep 11, 2024
1 parent 22b2a26 commit 3f2b732
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,21 @@ Currently, the following environment variables are defined:
- `TXL_DICTA_EP`: Endpoint for the Dicta Hebrew transliteration service. This
is mandatory for using the Hebrew module.

## Initial setup

In order to run Scriptshifter, a local SQLite database must be created. The
simplest way to do that is via command-line:

```bash
./sscli admin init-db
```

This step is already included in the `entrypoint.sh` script that gets executed
by Docker, so no additional action is necessary.

Note that the DB must be recreated every time any of the configuration tables
in `scriptshifter/tables/data` changes.

## Local development server

For local development, it is easiest to run Flask without the WSGI wrapper,
Expand Down

0 comments on commit 3f2b732

Please sign in to comment.