@opengeoweb/space-weather 13.0.0

package/README.md

@@ -0,0 +1,43 @@
+![current version](https://img.shields.io/badge/dynamic/json?color=blue&label=version&query=version&url=https://gitlab.com/opengeoweb/opengeoweb/raw/master/libs/space-weather/package.json)
+![coverage](https://gitlab.com/opengeoweb/opengeoweb/badges/master/coverage.svg?job=test-space-weather)
+
+# space-weather
+
+React component library with space-weather components for the opengeoweb project.
+This library was generated with [Nx](https://nx.dev).
+
+## Installation
+
+```
+npm install @opengeoweb/space-weather
+```
+
+## Use
+
+The front-end uses the [tanstack](https://tanstack.com/query) library to fetch data from the api. Importing components from the Space Weather repository should be wrapped by a QueryClient provider. Example:
+
+```
+import { QueryClientProvider } from '@tanstack/react-query';
+import { TimeSeries } from '@opengeoweb/space-weather';
+
+const Component = () =>
+    <QueryClientProvider client={queryClient}>
+        <TimeSeries />
+    </QueryClientProvider>
+```
+
+## Documentation
+
+https://opengeoweb.gitlab.io/opengeoweb/docs/space-weather/
+
+### API
+
+Documentation of the API can be found on Swagger (make sure you're connected to the KNMI network). There are three controllers:
+
+1. [TimeSeries API](http://ec2-34-242-250-251.eu-west-1.compute.amazonaws.com:8080/ui/#/time-series-controller)
+2. [Bulletin API](http://ec2-34-242-250-251.eu-west-1.compute.amazonaws.com:8080/bulletin/ui/)
+3. [Notification API](http://ec2-34-242-250-251.eu-west-1.compute.amazonaws.com:8080/notification/ui/)
+
+### TypeScript Documentation
+
+- [TypeScript Docs](https://opengeoweb.gitlab.io/opengeoweb/typescript-docs/space-weather/)

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./src/index";