Getting Started

Quickstart Guide

Get up and running in under 10 minutes

⏱ 10 min read

Quickstart Guide

Get your first AeThex project running in under 10 minutes.

Prerequisites

  • Node.js 18+ or Python 3.9+
  • An AeThex account (sign up free)
  • A code editor (VS Code recommended)

Step 1: Install the SDK

# Using npm
npm install @aethex/sdk

# Using yarn
yarn add @aethex/sdk

# Using Python
pip install aethex

Step 2: Initialize the Client

import { AeThex } from '@aethex/sdk';

const aethex = new AeThex({
  projectId: 'your-project-id',
  apiKey: 'your-api-key'
});

Step 3: Authenticate a User

// Start OAuth flow
const session = await aethex.auth.signIn({
  provider: 'google' // or 'discord', 'github', etc.
});

console.log('Welcome,', session.user.name);

Step 4: Make Your First API Call

// Get user profile
const profile = await aethex.identity.getProfile();

// Update display name
await aethex.identity.update({
  displayName: 'NewPlayer123'
});

Next Steps