Skip to content

Commit 4fbfbe6

Browse files
committed
update readme
1 parent 9462851 commit 4fbfbe6

File tree

1 file changed

+1
-37
lines changed

1 file changed

+1
-37
lines changed

README.md

+1-37
Original file line numberDiff line numberDiff line change
@@ -3,41 +3,5 @@
33
</p>
44
<p align="center"><i>Enabling society to collaborate. Building a better future, together.</i></p>
55

6-
# Alkemio Client Library
7-
The alkemio-lib package is for working directly with the Alkemio server, primarily using the graphql based api. For more details about Alkemio please visit either the [webiste](http://alkem.io) or [repo](http://github.com/alkem-io/alkemio).
6+
# Alkemio Space Ingestion Module
87

9-
The key capabilities of this package include:
10-
* Authentication to the Alkemio platform
11-
* Managing connections to the Alkemio api
12-
* Wrapping key Alkemio api capabilities in convenient local javascript calls, taking care of generating the graphql query / mutation and filling in parameters as appropriate
13-
14-
This package also provides a sample script, `src/validate-connection.ts`, to demonstrate the usage of the package.
15-
16-
Finally, this package provides a utility for carrying out performance test data population for a Alkemio server.
17-
18-
## Connecting to the Alkemio platform api
19-
To use this package, first instantiate an instance of the AlkemioClient class, passing in the Alkemio server end point:
20-
```
21-
const alkemioClient = new AlkemioClient({
22-
apiEndpointPrivateGraphql: 'http://localhost:3000/api/private/non-interactive/graphql',
23-
});
24-
```
25-
The alkemioClient can then be used to access the Alkemio server api using provided wrapper methods e.g.
26-
```
27-
await alkemioClient.testConnection();
28-
```
29-
The capabilities provided by the Alkemio server api is continually expanding, so not all capabillities of the server are guaranteed to be exposed by this package. For full details of the graphql api exposed by the Alkemio server please browse the schema for the graphql api via our [Dev environment](http://dev.alkem.io/graphql).
30-
31-
The set of wrapper calls provided is based on needs to date; feel free to augment with new ones as the needs arise.
32-
33-
## Authentication
34-
The following environment variables are used to specify the api endpoint and authentication parameters:
35-
36-
* API_ENDPOINT_PRIVATE_GRAPHQL=http://localhost:3000/api/private/non-interactive/graphql
37-
* AUTH_ORY_KRATOS_PUBLIC_BASE_URL=http://localhost:3000/ory/kratos/public
38-
* AUTH_ADMIN_EMAIL=[email protected]
39-
* AUTH_ADMIN_PASSWORD=changeMe
40-
*
41-
To set them, make a copy of the provided `.env.default` as `.env` and edit to reflect the target server values.
42-
43-
Other usages of client lib, such as from `populator`, are expected to provide the key parameters programmatically.

0 commit comments

Comments
 (0)