mirror of
https://gitlab.com/openstapps/openstapps.git
synced 2026-01-06 05:22:52 +00:00
feat: add api
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# @openstapps/api
|
||||
|
||||
Node.js library to interact with the StApps backend service
|
||||
|
||||
## Use this as a standalone program
|
||||
To get some data into a local `backend-node`-instance, you can run this
|
||||
as a standalone program to copy data of a remote `backend-node`-instance
|
||||
into your local one.
|
||||
|
||||
Example to copy all Events of the b-tu instance:
|
||||
```shell
|
||||
npm install
|
||||
npm run build
|
||||
node ./lib/cli.js copy -t Event --appVersion 1.0.0 https://stappsbe01.innocampus.tu-berlin.de http://localhost:3000
|
||||
```
|
||||
|
||||
### Program arguments:
|
||||
|
||||
```shell
|
||||
node ./lib/cli.js copy --appVersion <app version> -t <vc type> <source> <target>
|
||||
```
|
||||
|
||||
Example execution with docker when backend is running on `localhost:3000`:
|
||||
|
||||
```shell
|
||||
docker run --net=host registry.gitlab.com/openstapps/api/copy copy -t Place --appVersion 1.0.0 https://stappsbe01.innocampus.tu-berlin.de http://localhost:3000
|
||||
```
|
||||
Reference in New Issue
Block a user