elbx

Getting Started

Prerequisites

  • Node.js 18+
  • NPM or Yarn
  • API Key

Installation

npm create app@latest -t elbx
Use npm, yarn, or pnpm templates

Quick Start

npx elbx new my-project
  cd my-project
  npm install
  npm start
This will create and run the project

Setup Guide

  1. 1

    Create Project

    Use the CLI or our web interface to generate a new project template

  2. 2

    Configure SDK

    Set your API key in the .env file or configuration settings

  3. 3

    Build Components

    Create and test application components using our development tools

API Usage

Authentication

Required
Header Format
Authorization: Bearer <API_KEY>
Replace <API_KEY> with your personal access token
Get Current User
GET /api/v1/user
Returns the authenticated user's information. Requires Read scope.
Create Project
POST /api/v1/project
Creates a new project. Requires Write scope.
Sample Body: 
{
  "name": "my-new-app",
  "type": "web",
  "description": "Awesome new project"
}

SDK Examples

JavaScript
import { ElbxClient } from 'elbx-sdk'; const client = new ElbxClient({ apiKey: 'your-api-key' }); client.projects.create({ name: 'my-project', type: 'web' });
Python
from elbx import Client client = Client('your-api-key') client.projects.create( name='my-project', type='web' )

Configuration

Environment Variables

Create .env file:
ELBX_API_KEY=... ELBX_API_URL=https://api.elbx.com ELBX_PROJECT_ID=your-project
These variables will be loaded automatically in development mode

Configuration File

Create elbx.config.js:
module.exports = { apiKey: process.env.ELBX_API_KEY, projectId: process.env.ELBX_PROJECT_ID, env: 'dev' }
Configuration is automatically loaded in all development processes

CLI Commands

Common development commands:
elbx dev
elbx build
elbx deploy

Troubleshooting

Common Errors

  • 401
    Unauthorized
    Make sure API key is correctly set and has required scope
  • 404
    NotFound
    Double check the endpoint URI and project configuration
  • 500
    Server Error
    Check our status page for any ongoing issues

CLI Error Messages

  • ELBX_001: API_KEY_NOT_FOUND
    Set the ELBX_API_key environment variable
  • ELBX_002: INVALID_PROJECT_TYPE
    Only 'web', 'mobile', or 'server' are valid types