Skip to content

Commit

Permalink
Merge pull request #60 from kjsanger/docs/readme
Browse files Browse the repository at this point in the history
Add a note about installing on macOS
  • Loading branch information
nerdstrike authored Jun 13, 2024
2 parents 90a3fc5 + efb667f commit ec1a047
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,16 @@ uvicorn npg_porch.server:app --host 0.0.0.0 --port 8080 --reload --log-config lo

and open your browser at `http://localhost:8080` to see links to the docs.

On macOS you will need to ensure that a version of the `sqlite3` library that supports SQLite extensions
is used when installing the `pysqlite3` package. The system library on macOS does not, so an alternative
such as the one provided by MacPorts or Homebrew should be used. For example, when using MacPorts this
can be done by setting the `CPPFLAGS` environment variable before running the `pip install` command:

```
export CPPFLAGS="-I/opt/local/include"
```


The server will not start without `DB_URL` in the environment

## Running in production
Expand Down

0 comments on commit ec1a047

Please sign in to comment.