Skip to content

Latest commit

 

History

History
68 lines (51 loc) · 2.39 KB

README.md

File metadata and controls

68 lines (51 loc) · 2.39 KB

STAC-Admin 📡 📄

Introduction

The STAC-Admin is a tool designed for managing the values of a STAC (SpatioTemporal Asset Catalog) collection and its items. This interface provides a user-friendly way to modify and update the properties of collections and items within a STAC catalog.

Getting Started

Prerequisites

  • Node
  • Yarn

Installation

Install Yarn packages:

yarn install

Configuration

Before running the application, create a .env.local file with the required environment variable:

  • REACT_APP_STAC_API: Set this to the API endpoint of your STAC server.

⚠️ The current implementation of stac-admin works against the APIs provided by stac-fastapi's Transaction Extension. Make sure the extension is enabled and the server accepts PUT requests.

For example, you can use the local deployment of eoAPI with docker-compose to get up and running in minutes:

cd eoAPI
docker-compose up

In your .env.local file:

REACT_APP_STAC_API=http://localhost:8081

💡 See eoAPI directly for its getting started instruction and getting some sample data ingested.

Running the Application

To start the application in development mode:

yarn start

Open http://localhost:3000 to view it in your browser. The page will reload if you make edits, and lint errors will appear in the console.

Running Tests

Launch the test runner in interactive watch mode:

yarn test

More details can be found in the Create React App testing documentation.

Building for Production

Build the app for production:

yarn build

This bundles the app in production mode, optimizing the build for performance. The build is minified, and filenames include hashes.

Contributing

Contributions are welcome. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This project is licensed under the MIT license - see the LICENSE.md file for details.

Learn More