⌘K

Installation & Setup

Learn how to install and configure the #about SDK in your project. Support for Node.js, Deno, and modern bundlers.

Prerequisites

Before installing #about, ensure your environment meets the following requirements:

ℹ️
Platform Support

The #about SDK is fully compatible with serverless environments, edge runtimes, and traditional Node.js deployments.

Install via Package Manager

Run the following command in your project root:

bash 
# Using npm
npm install @about/core @about/cli

# Using pnpm
pnpm add @about/core @about/cli

# Using yarn
yarn add @about/core @about/cli

Initialize Your Project

After installation, run the setup wizard to configure your environment:

bash 
npx @about/cli init

? Select your runtime: Node.js
? Enable TypeScript? Yes
? Configure auth providers? OAuth2, JWT

✓ Project scaffolded successfully
💡
Pro Tip

Use the --template flag to skip the interactive wizard and generate a pre-configured project.

Basic Usage

Create your first about.config.ts file:

typescript 
import { defineConfig } from '@about/core';

export default defineConfig({
  app: {
    name: 'my-about-app',
    version: '1.0.0',
  },
  auth: {
    providers: ['github', 'google'],
    secret: process.env.ABOUT_SECRET,
  },
  database: {
    url: process.env.DATABASE_URL,
    pool: 10,
  },
});

Verify Installation

Run the health check command to ensure everything is configured correctly:

bash 
npx @about/cli doctor

✓ Node.js version compatible
✓ Environment variables loaded
✓ Database connection established
✓ Auth providers configured

Ready to build! 🚀
⚠️
Security Notice

Never commit .env files or API keys to version control. Use .env.example for template files.