C
CoderspaE
/Documentation

Installation Guide

Get started with CoderspaE by setting up your development environment and installing the necessary tools and SDKs.

Quick Start

The fastest way to get started with CoderspaE is through our web platform, but for advanced features and integrations, you can install our CLI tools and SDKs.

What You Need

  • • A modern web browser (Chrome, Firefox, Safari, Edge)
  • • Node.js 16+ (for CLI and SDK usage)
  • • Python 3.8+ (for Python SDK)
  • • Git (for repository integrations)
  • • A CoderspaE account (free to create)

Web Platform

Create Your Account

Start coding immediately with our web-based platform:

1. Visit https://coderspae.com
2. Click "Sign Up" 
3. Choose your preferred method:
   - Email and password
   - Google OAuth
   - GitHub OAuth
   - Discord OAuth
4. Complete your profile
5. Start your first coding battle!

Command Line Interface (CLI)

Installation

npm (Recommended)

# Install globally
npm install -g @coderspae/cli

# Verify installation
coderspae --version

# Login to your account
coderspae auth login

Yarn

# Install globally
yarn global add @coderspae/cli

# Verify installation
coderspae --version

SDK Installation

JavaScript/TypeScript SDK

# npm
npm install @coderspae/sdk

# yarn
yarn add @coderspae/sdk

# Basic usage
import { CoderspaE } from '@coderspae/sdk';

const client = new CoderspaE({
  apiKey: 'your-api-key'
});

Python SDK

# pip
pip install coderspae

# Basic usage
import coderspae

client = coderspae.Client(api_key='your-api-key')

React Components

# React components library
npm install @coderspae/react

# Usage
import { BattleArena, CodeEditor } from '@coderspae/react';

function App() {
  return (
    <BattleArena problemId="two-sum">
      <CodeEditor language="javascript" />
    </BattleArena>
  );
}

Development Environment

VS Code Extension

# From VS Code
1. Open VS Code
2. Go to Extensions (Ctrl+Shift+X)
3. Search for "CoderspaE"
4. Click Install

# From command line
code --install-extension coderspae.coderspae-vscode

Configuration

# Set API key
export CODERSPAE_API_KEY="your-api-key-here"

# Or configure with CLI
coderspae config set api-key your-api-key-here

# Verify setup
coderspae auth status

Next Steps

🚀 Get Started

  • • Join your first battle: coderspae battle join
  • • Explore problems: coderspae problems list
  • • Read the Authentication Guide