Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2026-01-09 19:22:51 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor: build system

Browse Source
This commit is contained in:
Thea Schöbl
2023-03-22 11:45:30 +01:00
parent 4df19e8c20
commit 8cb9285462
427 changed files with 3978 additions and 9810 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
examples/minimal-plugin/README.md
View File

@@ -2,8 +2,8 @@
## Prerequisites
* `node` and `npm` installed
* a backend, which is running locally (e.g. on http://localhost:3000)
- `node` and `npm` installed
- a backend, which is running locally (e.g. on http://localhost:3000)
## How to get started
@@ -25,7 +25,7 @@ To start the plugin, you need to execute the code in "CLI" script:
node lib/cli.js -b <backendURL> -n <pluginName> -r <routeName> -u <URL> -p <port>
With fallback values being:
backendURL = http://localhost:3000 , pluginName = minimal-plugin ,
backendURL = http://localhost:3000 , pluginName = minimal-plugin ,
routeName = minimalplugin , URL = http://localhost, port = 4000
```
@@ -33,26 +33,26 @@ Using environment variables you can set backendURL via `STAPPS_BACKEND`, URL via
## Creating your own plugin
* Modify the default values in `cli.ts` to your needs:
* update the name
* update the port
* update the route
* update your request and response names (You need these in a bit)
* Rename the `minimal-plugin.ts` and the `MinimalPlugin` class to a more suitable name and adjust the imports in other files
* Delete the `sum` function in `minimal-plugin.ts` and write your own logic inside the `onRouteInvoke` function
* Define the layout of your http requests and responses inside the `/plugin/protocol` folder. The names of the interfaces
need to be the same as the request and response names you defined in the `cli.ts`
- Modify the default values in `cli.ts` to your needs:
- update the name
- update the port
- update the route
- update your request and response names (You need these in a bit)
- Rename the `minimal-plugin.ts` and the `MinimalPlugin` class to a more suitable name and adjust the imports in other files
- Delete the `sum` function in `minimal-plugin.ts` and write your own logic inside the `onRouteInvoke` function
- Define the layout of your http requests and responses inside the `/plugin/protocol` folder. The names of the interfaces
need to be the same as the request and response names you defined in the `cli.ts`
## Code structure
Folder `src` contains:
* Reference implementations for CLI and a plugin
* [/cli.ts](src/cli.ts)
* minimal CLI to start your connector, that uses CLI-args, so that there are no hard coded values for configuration
* will execute the specified connectors and push the data to the backend
* [/common.ts](src/common.ts) blank file for commonly used values across files to put in
* [/plugin/minimal-connector.ts](src/plugin/minimal-plugin.ts) minimal plugin class with some example logic
* [/plugin/protocol/request.ts](src/plugin/protocol/request.ts) the interface for any incoming http requests
* [/plugin/protocol/response.ts](src/plugin/protocol/response.ts) the interface for responses by the plugin to the backend
* [/plugin/protocol/tsconfig.json](src/plugin/protocol/response.ts) required by schema generator
- Reference implementations for CLI and a plugin
- [/cli.ts](src/cli.ts)
- minimal CLI to start your connector, that uses CLI-args, so that there are no hard coded values for configuration
- will execute the specified connectors and push the data to the backend
- [/common.ts](src/common.ts) blank file for commonly used values across files to put in
- [/plugin/minimal-connector.ts](src/plugin/minimal-plugin.ts) minimal plugin class with some example logic
- [/plugin/protocol/request.ts](src/plugin/protocol/request.ts) the interface for any incoming http requests
- [/plugin/protocol/response.ts](src/plugin/protocol/response.ts) the interface for responses by the plugin to the backend
- [/plugin/protocol/tsconfig.json](src/plugin/protocol/response.ts) required by schema generator