Matat Docs

Getting Started with Matat

Step-by-step guide to configure, deploy, and start building with Matat.

1. Installation

Install Matat using our provided CLI tool or directly from our repository.


npm install -g @matat/cli
matat init project-name

Follow the prompts to select a template or create a blank project.

2. Configuration

Configure your project using the matat.config.js file.


module.exports = {
  projectId: 'your-project-id',
  environment: 'development',
  apiKey: 'your-api-key'
}

Replace placeholders with values from your Matat dashboard.

3. Start Developing

Start the development server and open your project in the browser.


cd project-name
matat start

Open http://localhost:3000 to view your new project.

Quick API Integration

Use our API to create a task programmatically:


curl -X POST 'https://api.matat.io/v1/tasks'
  -H 'Authorization: Bearer {YOUR_API_KEY}'
  -H 'Content-Type: application/json'
  -d '{
    "title": "My First Task",
    "priority": 3,
    "deadline": "2025-12-31"
}'

See full API documentation here.

Next: API Reference ➡