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: docs/README.md
+11-5Lines changed: 11 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,10 +10,10 @@ STAC-Manager is a react app designed for managing the values of a STAC (SpatioTe
10
10
The ecosystem is composed of a web app (the client) and a plugin system that powers it.
11
11
The different parts of the project are located in the `packages` directory structured as follows:
12
12
13
-
-[`@stac-manager/client`](./packages/client) - STAC-Manager web app.
14
-
-[`@stac-manager/data-core`](./packages/data-core) - Core functionality of the form builder plugin system.
15
-
-[`@stac-manager/data-widgets`](./packages/data-widgets) - Form components to be used by the form builder plugin system, when custom ones are not provided.
16
-
-[`@stac-manager/data-plugins`](./packages/data-plugins) - Data plugins for the forms. Each plugin defines how a section of the data structure is displayed and edited.
13
+
-[`@stac-manager/client`](../packages/client) - STAC-Manager web app.
14
+
-[`@stac-manager/data-core`](../packages/data-core) - Core functionality of the form builder plugin system.
15
+
-[`@stac-manager/data-widgets`](../packages/data-widgets) - Form components to be used by the form builder plugin system, when custom ones are not provided.
16
+
-[`@stac-manager/data-plugins`](../packages/data-plugins) - Data plugins for the forms. Each plugin defines how a section of the data structure is displayed and edited.
17
17
18
18
The `@stac-manager/data-*` packages contain the default implementation of the plugin system, the widgets used to render the forms and some core functions to allow the system to be extended.
19
19
@@ -22,12 +22,18 @@ Each plugin handles a specific part of the data and is responsible for defining
22
22
23
23
## Configuration
24
24
25
+
### Client
26
+
27
+
See the client-specific instructions, such as configuring the server's STAC API, in the [README of the client package](../packages/client#client-specific-instructions).
28
+
29
+
### Plugins
30
+
25
31
STAC-Manager's [config file](/packages/client/src/plugin-system/config.ts) specifies the plugins that the app uses for Collections and Items while extending the `Default Plugin Widget Configuration` which defines the widgets for the basic field types.
26
32
_See the [data-widgets/config](/packages/data-widgets/lib/config/index.ts) for a list of existent widgets._
27
33
28
34
When creating a new plugin or a new widget, the configuration should be updated with the new plugin/widget.
29
35
30
-
### Example config
36
+
####Example config
31
37
32
38
The config object should contain a list of plugins to use for the collections and items, as well as the widget configuration (which widgets to use for which field types).
0 commit comments