Skip to content

Commit edcfeb4

Browse files
committed
mention browser in README, improve structure of README for deployment
1 parent b69a779 commit edcfeb4

File tree

1 file changed

+20
-9
lines changed

1 file changed

+20
-9
lines changed

README.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,8 @@
3232

3333
- **OGC Features and Vector Tiles** API built on top of [https://github.com/developmentseed/tipg](https://github.com/developmentseed/tipg)
3434

35+
- **A STAC Catalog browsing UI** based on the radiant earth browser : [https://github.com/radiantearth/stac-browser](https://github.com/radiantearth/stac-browser)
36+
3537
---
3638

3739
## 🌍 eoAPI: An Open-Source Community Project
@@ -57,22 +59,19 @@ Then you can start exploring your dataset with:
5759

5860
- the STAC Metadata service [http://localhost:8081](http://localhost:8081)
5961
- the Raster service [http://localhost:8082](http://localhost:8082)
62+
- the browser UI [http://localhost:8085](http://localhost:8085)
6063

6164
If you've added a vector dataset to the `public` schema in the Postgres database, they will be available through the **Vector** service at [http://localhost:8083](http://localhost:8083).
6265

63-
## Deployment
66+
## Deployment with standard runtimes
6467

6568
This repository has current runtimes that are consistently updated with new functionality.
6669

67-
The services can be deployed locally via docker with `docker compose up`.
68-
69-
Two Infrastructure as Code (IaC) repositories are available:
70-
- [eoapi-cdk](https://github.com/developmentseed/eoapi-cdk): A set of AWS CDK constructs to deploy eoAPI services
71-
- [eoapi-k8s](https://github.com/developmentseed/eoapi-k8s): IaC and Helm charts for deploying eoAPI services on AWS and GCP
70+
### Local deployment
7271

73-
Finally, [eoapi-template](https://github.com/developmentseed/eoapi-template) is an AWS CDK app that shows how to configure the eoapi-cdk constructs.
72+
The services can be deployed altogether locally with `docker compose up`.
7473

75-
Alternatively, you may install the libraries locally:
74+
Alternatively, you may install the libraries and launch the applications manually :
7675

7776
<details>
7877

@@ -109,7 +108,19 @@ Note: python libraries might have incompatible dependencies, which you can resol
109108

110109
</details>
111110

112-
## Custom runtimes
111+
### Deployment on the cloud
112+
113+
#### Kubernetes
114+
115+
[eoapi-k8s](https://github.com/developmentseed/eoapi-k8s) contains IaC and Helm charts for deploying eoAPI services on AWS and GCP.
116+
117+
#### AWS CDK
118+
119+
[eoapi-cdk](https://github.com/developmentseed/eoapi-cdk) defines a set of AWS CDK constructs that can be used to deploy eoAPI services on AWS. This repository itself makes use of these in `infrastructure/aws`. An official example usage of these constructs can be found at [eoapi-template](https://github.com/developmentseed/eoapi-template).
120+
121+
122+
123+
## Deployment with custom runtimes
113124

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

0 commit comments

Comments
 (0)