Quickstart Guide

Get up and running with DevForge in under 5 minutes.

0 Prerequisites

Before you begin, make sure you have:

  • Node.js 18+ or Python 3.8+
  • A DevForge account (sign up free)
  • Basic knowledge of REST APIs

1 Create Your API Key

First, create an API key from your dashboard. API keys authenticate your requests to DevForge.

  1. 1. Navigate to the API Keys section in your dashboard
  2. 2. Click "Create New Key" and give it a descriptive name
  3. 3. Copy your key immediately - it won't be shown again!

Security Notice

Never expose your API key in client-side code or commit it to version control.

2 Install the SDK

Install the DevForge SDK for your preferred language:

terminal
$ npm install @devforge/sdk
# or with yarn
$ yarn add @devforge/sdk

3 Initialize the Client

Set up the DevForge client with your API key:

index.js
import { DevForge } from '@devforge/sdk';

// Initialize the client
const client = new DevForge({
  apiKey: process.env.DEVFORGE_API_KEY,
});

4 Make Your First API Call

Let's create a project and fetch some data:

index.js
// Create a new project
const project = await client.projects.create({
  name: 'my-first-project',
  description: 'Testing DevForge API',
});

console.log('Project created:', project.id);

// List all projects
const projects = await client.projects.list();
console.log('Total projects:', projects.length);

Output:

Project created: proj_abc123xyz
Total projects: 1

You're all set!

You've successfully made your first API call. Explore the resources below to learn more.