Skip to main content

Installation Guide

Prerequisites​

Before installing the Bolt SDK, ensure you have the following:

  • Node.js (version 14 or above)
  • npm or yarn package manager
  • An API key from Bolt (replace 'YOUR_API_KEY' in code examples with your actual API key)

Installation Steps​

1. Initialize Your Project​

If you haven't already, create a new Node.js project:

mkdir my-lightlink-project
cd my-lightlink-project
npm init -y

2. Install the SDK​

Install the lightlink-bolt-sdk package from npm:

npm install lightlink-bolt-sdk

If you're using TypeScript, install it as a development dependency:

npm install typescript --save-dev

4. Set Up TypeScript Configuration​

Create a tsconfig.json file in your project root with the following content:

{
  "compilerOptions": {
    "target": "ES2015",
    "module": "commonjs",
    "lib": ["ES2015", "DOM"],
    "strict": true,
    "esModuleInterop": true,
    "skipLibCheck": true,
    "forceConsistentCasingInFileNames": true
  },
  "include": ["./**/*.ts"],
  "exclude": ["node_modules", "dist"]
}

5. You're Ready to Go!​

You can now start using the SDK in your project. Proceed to the Usage Guides for instructions on how to interact with different modules of the SDK.