Skip to content

Commit

Permalink
chore: add section on installing and running the api
Browse files Browse the repository at this point in the history
  • Loading branch information
Erin van der Veen committed May 6, 2024
1 parent e99da1c commit 501393d
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 @@ -41,6 +41,21 @@ However, in this case you are sponsible for ensuring the dependencies are availa
cargo install --git https://github.com/tweag/genealogos.git genealogos-cli
```

## Installing Genealogos-api (and frontend)
The installation methods for the cli can easily be adjusted for the api.
```fish
# To run once
nix run github:tweag/genealogos#genealogos-api
# To temporarily add to $PATH
nix shell github:tweag/genealogos#genealogos-api
# Cargo install
cargo install --git https://github.com/tweag/genealogos.git genealogos-api
```

The `frontend` feature is enabled by default, so once the api is running open `http://localhost:8000/` for the frontend.

## Hacking
### Prerequisites
Development of Genealogos requires Cargo, and some other dependencies.
Expand Down

0 comments on commit 501393d

Please sign in to comment.