Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos/grammar in README.md #180

Merged
merged 2 commits into from
Feb 29, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ cd eoAPI
docker compose up
```

Once the applications are *up*, you'll need to add STAC **Collections** and **Items** to the PgSTAC database. If you don't have, you can use the follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)).
Once the applications are *up*, you'll need to add STAC **Collections** and **Items** to the PgSTAC database. If you don't have these available, you can follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](https://github.com/developmentseed/eoAPI/tree/main/demo)).

Then you can start exploring your dataset with:

Expand All @@ -71,7 +71,7 @@ This repository has current runtimes that are consistently updated with new func

The services can be deployed altogether locally with `docker compose up`.

Alternatively, you may install the libraries and launch the applications manually :
Alternatively, you may install the libraries and launch the applications manually:

<details>

Expand Down Expand Up @@ -104,7 +104,7 @@ python -m pip install tipg
.venv/bin/uvicorn tipg.main:app --port 8083 --reload
```

Note: python libraries might have incompatible dependencies, which you can resolve by using a virtual environment for each ones
Note: Python libraries might have incompatible dependencies, which you can resolve by using a virtual environment for each one.

</details>

Expand All @@ -124,7 +124,7 @@ Note: python libraries might have incompatible dependencies, which you can resol

The eoAPI repository hosts customized versions of each base service which can work in parallel or in combination with each other.

eoAPI custom runtimes can be launched with docker
eoAPI custom runtimes can be launched with docker:

```
docker compose -f docker-compose.custom.yml --profile gunicorn up
Expand All @@ -144,7 +144,7 @@ export DATABASE_URL=postgresql://username:password@0.0.0.0:5439/postgis # Conne
.venv/bin/uvicorn eoapi.{SERVICE}.app:app --port 8000 --reload
```

Note: services might have incompatible dependencies, which you can resolve by using a virtual environment for each service
Note: services might have incompatible dependencies, which you can resolve by using a virtual environment for each service.

## Contribution & Development

Expand Down
Loading