You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+52-88Lines changed: 52 additions & 88 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,35 +8,39 @@ implemented as a single page application (SPA) for ease of development and to
8
8
limit the overall number of catalog reads necessary when browsing (as catalogs
9
9
may be nested and do not necessarily contain references to their parents).
10
10
11
-
Version: **3.2.0** (supports all STAC versions between 0.6.0 and 1.1.0)
11
+
Version: **3.3.4** (supports all STAC versions between 0.6.0 and 1.1.0)
12
12
13
13
This package has also been published to npm as [`@radiantearth/stac-browser`](https://www.npmjs.com/package/@radiantearth/stac-browser).
14
14
15
15
It's not officially supported, but you may also be able to use it for
16
16
certain _OGC API - Records_ and _OGC API - Features_ compliant servers.
17
17
18
-
**Please note that STAC Browser is currently without funding for both maintenance, bug fixes and improvements. This means issues and PRs may be addressed very slowly.
18
+
**Please note that STAC Browser is currently with limited funding for both maintenance, bug fixes and improvements. This means issues and PRs may be addressed very slowly.
19
19
If you care about STAC Browser and have some funds to support the future of STAC Browser, please contact [email protected]**
-[Customize through root catalog](#customize-through-root-catalog)
39
+
-[Custom extensions](#custom-extensions)
40
+
-[Docker](#docker)
41
+
-[Contributing](#contributing)
42
+
-[Adding a new language](#adding-a-new-language)
43
+
-[Sponsors](#sponsors)
40
44
41
45
## Examples
42
46
@@ -74,6 +78,9 @@ npm run build -- --catalogUrl="https://earth-search.aws.element84.com/v1/"
74
78
This will only work on the root path of your domain though. If you'd like to publish in a sub-folder,
75
79
you can use the [`pathPrefix`](docs/options.md#pathprefix) option.
76
80
81
+
> [!NOTE]
82
+
> If you are using a recent version of node/npm on Windows, you may need to use `npm run build -- -- ...` instead of `npm run build -- ...`, see <https://github.com/npm/cli/issues/7375> for details.
83
+
77
84
After building, `dist/` will contain all assets necessary
78
85
host the browser. These can be manually copied to your web host of choice.
79
86
**Important:** If `historyMode` is set to `history` (which is the default value), you'll need to add
@@ -116,19 +123,31 @@ You need to change the [`locale`](docs/options.md#locale) and [`supportedLocales
116
123
117
124
The following languages are currently supported:
118
125
119
-
- German (Germany, Switzerland)
120
-
- Spanish
121
-
- English (International, US, UK)
122
-
- French (Canada, France, Switzerland)
123
-
- Italian (Italy, Switzerland)
124
-
- Romanian
125
-
- Japanese
126
-
- Portuguese (Brazil, Portugal)
126
+
- Arabic `ar`
127
+
- German `de` (Germany `de`, Switzerland `de-CH`)
128
+
- Spanish `es`
129
+
- English `en` (International `en`, US `en-US`, UK `en-GB`)
130
+
- French `fr` (Canada `fr-CA`, France `fr`, Switzerland `fr-CH`)
131
+
- Italian `it` (Italy `it`, Switzerland `it-CH`)
132
+
- Romanian `ro`
133
+
- Japanese `ja`
134
+
- Portuguese `pt` (Brazil `pt-BR`, Portugal `pt`)
127
135
128
136
We manage the translations in Crowdin, please see <https://crowdin.com/project/stac-browser/> for details.
129
137
130
138
To add your own language, please follow the guide below: [Adding a new language](#adding-a-new-language)
131
139
140
+
The following contributors kindly provide the translations:
All other options, except the ones that are explicitly excluded from CLI/ENV usage,
288
-
can be passed as environment variables when running the container.
289
-
For example, to run the container with a pre-defined
290
-
[`catalogUrl`](docs/options.md#catalogurl) and [`catalogTitle`](docs/options.md#catalogtitle):
291
-
292
-
```bash
293
-
docker run -p 8080:8080 -e SB_catalogUrl="https://earth-search.aws.element84.com/v1/" -e SB_catalogTitle="Earth Search" stac-browser:v1
294
-
```
295
-
296
-
If you want to pass all the other arguments to `npm run build` directly, you can modify to the Dockerfile as needed.
297
-
298
-
STAC browser is now available at `http://localhost:8080/browser`
299
-
300
-
### Use an existing image
301
-
302
-
Since version 3.1.1, you can add an existing image from [Packages](https://github.com/radiantearth/stac-browser/pkgs/container/stac-browser) to your docker-compose.yml:
303
-
304
-
```
305
-
services:
306
-
stac-browser:
307
-
image: ghcr.io/radiantearth/stac-browser:latest
308
-
ports:
309
-
- 8080:8080
310
-
environment:
311
-
SB_catalogUrl: "https://localhost:7188"
312
-
```
274
+
You can use the Docker to work with STAC Browser. Please read [Docker documentation](docs/docker.md) for more details.
313
275
314
276
## Contributing
315
277
@@ -356,8 +318,10 @@ You can also use one of the existing languages and provide an alternate version
356
318
The following sponsors have provided a substantial amount of funding for STAC Browser in the past:
357
319
358
320
-[Radiant Earth](https://radiant.earth) (base funding for versions 1, 2 and 3)
321
+
-[swisstopo](https://www.swisstopo.admin.ch/) (maintenance, base funding for version 3 and 4)
0 commit comments