Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mfenner committed Oct 7, 2023
1 parent fc3c68f commit 058260b
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,15 @@

# rogue-scholar-api

The Python backend for the [Rogue Scholar](https://rogue-scholar.org) science blog archive.
The backend server for the [Rogue Scholar](https://rogue-scholar.org) science blog archive. The Rogue Scholar API is a [Quart](https://pgjones.gitlab.io/quart/) application that provides a RESTful API for the Rogue Scholar service.

## Installation

Coming soon.
Requires Python 3.8 or higher. Uses [Poetry](https://python-poetry.org/) for dependency management. Depends on credentials for the Rogue Scholar Postgres database (hosted by Supabase) and Rogue Scholar search index (hosted by Typesense).

```
quart --app rogue_scholar run
```

## Development

Expand Down

0 comments on commit 058260b

Please sign in to comment.