-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updating readme to better reflect dev setup process
- Loading branch information
Showing
1 changed file
with
23 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,26 @@ | ||
## Project Name: geneweaver-api | ||
# Geneweaver 3 API | ||
|
||
Description: description | ||
Description: The API for the Geneweaver v3 application ecosystem. | ||
|
||
App: geneweaver_api | ||
## Setup | ||
|
||
To run the app execute `uvicorn geneweaver_api.main:app --reload` | ||
### Local | ||
|
||
#### Requirements | ||
|
||
- Python Poetry | ||
- Python 3.9 or higher | ||
- A connection to a copy of the Geneweaver Database | ||
|
||
#### Setup | ||
|
||
1. Clone the repository | ||
2. Run `poetry install` in project root to install dependencies | ||
3. Configure environment settings with environment variables or a `.env` file. | ||
4. Run the application | ||
|
||
To run the app execute either `uvicorn geneweaver.api.main:app --reload` with the poetry | ||
virtualenv activated, or just run `poetry run uvicorn geneweaver.api.main:app --reload`. | ||
|
||
This will host the application on `http://127.0.0.1:8000/` which means the swagger docs | ||
page is available at `http://127.0.0.1:8000/docs`. |