![\"Alkemio](\"https://alkemio.foundation/uploads/logos/alkemio-logo.svg\"){kind=logo}
\n\n \n
Enabling society to collaborate. Building a better future, together.
\n\n# Alkemio Client Library\nThe 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).\n\nThe key capabilities of this package include:\n* Authentication to the Alkemio platform\n* Managing connections to the Alkemio api\n* Wrapping key Alkemio api capabilities in convenient local javascript calls, taking care of generating the graphql query / mutation and filling in parameters as appropriate\n\nThis package also provides a sample script, `src/validate-connection.ts`, to demonstrate the usage of the package.\n\nFinally, this package provides a utility for carrying out performance test data population for a Alkemio server.\n\n## Connecting to the Alkemio platform api\nTo use this package, first instantiate an instance of the AlkemioClient class, passing in the Alkemio server end point:\n```\n const alkemioClient = new AlkemioClient({\n apiEndpointPrivateGraphql: 'http://localhost:3000/api/private/non-interactive/graphql',\n });\n ```\nThe alkemioClient can then be used to access the Alkemio server api using provided wrapper methods e.g.\n```\n await alkemioClient.testConnection();\n```\nThe 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).\n\nThe set of wrapper calls provided is based on needs to date; feel free to augment with new ones as the needs arise.\n\n## Authentication\nThe following environment variables are used to specify the api endpoint and authentication parameters:\n\n* API_ENDPOINT_PRIVATE_GRAPHQL=http://localhost:3000/api/private/non-interactive/graphql\n* AUTH_ORY_KRATOS_PUBLIC_BASE_URL=http://localhost:3000/ory/kratos/public\n* AUTH_ADMIN_EMAIL=admin@alkem.io\n* AUTH_ADMIN_PASSWORD=changeMe\n*\nTo set them, make a copy of the provided `.env.default` as `.env` and edit to reflect the target server values.\n\nOther usages of client lib, such as from `populator`, are expected to provide the key parameters programmatically.\n","readmeFilename":"README.md"}