graphlit-client-typescript v1.0.0

TypeScript Client for Graphlit Platform

Overview

The Graphlit Client for Node.js enables straightforward interactions with the Graphlit API, allowing developers to execute GraphQL queries and mutations against the Graphlit service. This document outlines the setup process and provides a basic example of using the client.

Prerequisites

Before you begin, ensure you have the following:

• Node.js installed on your system (recommended version 12.x or higher).
• An active account on the Graphlit Platform with access to the API settings dashboard.

Installation

To install the Graphlit Client, use npm or yarn:

npm install graphlit-client

or

yarn add graphlit-client

Configuration

The Graphlit Client requires certain environment variables to be set for authentication and configuration:

• ENVIRONMENT_ID: Your environment ID.
• ORGANIZATION_ID: Your organization ID.
• SECRET_KEY: Your secret key for API access.

You can find these values in the API settings dashboard on the Graphlit Platform.

Setting Environment Variables

To set these environment variables on your system, you can place them in a .env file at the root of your project:

ENVIRONMENT_ID=your_environment_id_value
ORGANIZATION_ID=your_organization_id_value
SECRET_KEY=your_secret_key_value

Ensure your project uses the dotenv package to load these variables:

npm install dotenv

Then, at the start of your application, add:

require('dotenv').config();

Support

Please refer to the Graphlit API Documentation.

For support with the Graphlit Client, please submit a GitHub Issue.

For further support with the Graphlit Platform, please join our Discord community.