Skip to content

Commit

Permalink
Docs/partner update (#111)
Browse files Browse the repository at this point in the history
* Add references to default runtimes

Add references to default runtimes under a deployment section in the README. References the two distinct repositories: eoapi-cdk and k8s-eoapi.

* Add linkedin and rss footer to documentation

* Fix reference to rss logo
  • Loading branch information
zacharyDez authored Jul 13, 2023
1 parent 73cc5dd commit 749b85d
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 4 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
- Navigate to the project: `cd eoAPI`
- Run services with `docker-compose up`
- Follow the [MAXAR open data demo](https://github.com/vincentsarago/MAXAR_opendata_to_pgstac) (or get inspired by the other [demos](./demo/)) to load some data into eoAPI
- Checkout the [Search Viewer](http://localhost:8081/index.html), and the API documentation ([STAC Metadata](http://localhost:8081/docs), [Raster Tiles](http://localhost:8082/docs), [Vector Tiles](http://localhost:8083/api.html))
- Check out the [Search Viewer](http://localhost:8081/index.html), and the API documentation ([STAC Metadata](http://localhost:8081/docs), [Raster Tiles](http://localhost:8082/docs), [Vector Tiles](http://localhost:8083/api.html))

Alternatively, you may launch the application locally:
```bash
Expand All @@ -56,10 +56,16 @@ export DATABASE_URL=postgresql://username:[email protected]: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 virtual environnement per service
Note: services might have incompatible dependencies which you can resolve by using a virtual environment for each service

---

## Deployment

This repository has the demonstration runtimes that are consistently updated with new functionality.

The default runtimes are available through separate repositories ([eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) and [k8s-eoapi](https://github.com/developmentseed/k8s-eoapi)).

## Contribution & Development

See [CONTRIBUTING.md](https://github.com/developmentseed/eoAPI/blob/main/CONTRIBUTING.md)
Expand Down
6 changes: 4 additions & 2 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,10 @@ extra:
link: "https://github.com/developmentseed"
- icon: "fontawesome/brands/twitter"
link: "https://twitter.com/developmentseed"
- icon: "fontawesome/brands/medium"
link: "https://medium.com/devseed"
- icon: "fontawesome/brands/linkedin"
link: "https://www.linkedin.com/company/development-seed"
- icon: "fontawesome/solid/rss"
link: "https://developmentseed.org/blog"

nav:
- Home: "index.md"
Expand Down

0 comments on commit 749b85d

Please sign in to comment.