Getting Started

Introduction

Welcome to the WebMatrix documentation. This guide will help you understand our core concepts, learn how to install and configure our SDKs, and provide comprehensive API references to help you build powerful applications.

Installation

The easiest way to get started is by using our CLI tool. It will automatically scaffold a new project and configure all necessary dependencies.

Terminal

npx create-webmatrix-app@latest my-app

Alternatively, you can install the core packages manually via npm or yarn:

npm install @webmatrix/core @webmatrix/react

Quickstart

Once installed, wrap your application with the WebMatrixProvider to initialize the client state.

app/layout.tsx

import { WebMatrixProvider } from '@webmatrix/react';export default function RootLayout({ children }) {return (<html><body><WebMatrixProvider apiKey="YOUR_API_KEY">{children}</WebMatrixProvider></body></html>);}

Authentication API

All API requests must be authenticated using a Bearer token. You can generate API keys from your dashboard.

GET/v1/users/me

Retrieves the currently authenticated user's profile information.

Headers

Name	Value
Authorization	Bearer <token>