Quick Start
Set up DevMatrix in your project in less than 5 minutes: install the client, configure it, and create your first project.
PrerequisitesMake sure you have Node.js 18.17 or later installed. We recommend using
npm or pnpm.1. Installation
Install the core DevMatrix client into your Next.js or Node.js environment.
terminal
npm install @devmatrix/core
2. Setup your workspace
Initialize the DevMatrix client. If you're using TypeScript, the types are included out of the box. Create a new file called matrix.config.ts in your root directory.
matrix.config.ts
import { MatrixClient } from '@devmatrix/core';
// Initialize the client with your secret key
export const matrix = new MatrixClient({
apiKey: process.env.DEVMATRIX_API_KEY,
environment: 'development',
options: {
enableAnalytics: true,
syncWorkflows: true
}
});3. Create your first project
Every module — API Playground, AI Debugging, Analytics, and the Idea Validator — needs a project to attach to. Create one from the client:
create-project.ts
const project = await matrix.projects.create({
name: 'My First Project',
description: 'Testing DevMatrix locally',
type: 'web',
});
console.log(project.id); // use this in the dashboardPro TipYou can seamlessly integrate DevMatrix with your Next.js App Router API routes to handle authentication and webhooks directly from the server side.
Next Steps
With a project created, head into any module to start using it — send your first request in the API Playground, or connect a repository to Developer Analytics.