Skip to main content

Quickstart Guide

Get your first project running in under 5 minutes. This guide covers the fastest path from signup to coding.

Step 1: Create Your Account

  1. Navigate to auth.coditect.ai
  2. Click Sign Up or Get Started
  3. Enter your email address and create a password
  4. Verify your email (check your inbox for the confirmation link)
Google Sign-In

For faster onboarding, use Sign in with Google to skip email verification.

Step 2: Set Up Your Organization

After signing in, you'll be prompted to create or join an organization:

  1. Create Organization: Enter your organization name (e.g., "Acme Engineering")
  2. Select Plan: Choose your subscription tier (Free tier available for evaluation)
  3. Confirm: Click Create Organization

Step 3: Create Your First Project

  1. From the dashboard, click New Project

  2. Choose a template:

    • Blank Project: Start from scratch
    • React Starter: Pre-configured React + TypeScript
    • Python API: FastAPI backend template
    • Full Stack: React frontend + Python backend
  3. Name your project and click Create

# Your project is now being provisioned...
# This typically takes 10-30 seconds

Step 4: Launch Your Workstation

  1. Click Open Workstation on your project card
  2. Wait for the cloud environment to initialize (first launch takes ~30 seconds)
  3. You're now in the CODITECT IDE with AI assistance enabled!

Step 5: Try AI-Assisted Coding

Open a file and try the AI assistant:

// Type a comment describing what you want, then press Tab
// Example: Create a function that validates email addresses

function validateEmail(email: string): boolean {
// AI will suggest the implementation
const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
return emailRegex.test(email);
}

AI Commands

CommandAction
TabAccept AI suggestion
EscDismiss suggestion
Cmd/Ctrl + KOpen AI chat panel
Cmd/Ctrl + Shift + RRefactor selected code

Step 6: Preview Your Application

  1. Click the Preview button in the toolbar
  2. A preview URL will be generated (e.g., https://preview-abc123.coditect.dev)
  3. Share this URL with teammates for instant feedback

What's Next?

Now that you have a running project, explore these guides:

Example: Build a Todo API

Here's a complete example to try in your new project:

# main.py - A simple Todo API
from fastapi import FastAPI, HTTPException
from pydantic import BaseModel
from typing import List, Optional

app = FastAPI(title="Todo API")

class Todo(BaseModel):
id: Optional[int] = None
title: str
completed: bool = False

todos: List[Todo] = []

@app.get("/todos", response_model=List[Todo])
def list_todos():
"""List all todos"""
return todos

@app.post("/todos", response_model=Todo)
def create_todo(todo: Todo):
"""Create a new todo"""
todo.id = len(todos) + 1
todos.append(todo)
return todo

@app.put("/todos/{todo_id}", response_model=Todo)
def update_todo(todo_id: int, updated: Todo):
"""Update a todo by ID"""
for i, todo in enumerate(todos):
if todo.id == todo_id:
updated.id = todo_id
todos[i] = updated
return updated
raise HTTPException(status_code=404, detail="Todo not found")

@app.delete("/todos/{todo_id}")
def delete_todo(todo_id: int):
"""Delete a todo by ID"""
for i, todo in enumerate(todos):
if todo.id == todo_id:
todos.pop(i)
return {"message": "Todo deleted"}
raise HTTPException(status_code=404, detail="Todo not found")

Run with:

uvicorn main:app --reload

Then visit http://localhost:8000/docs to see the interactive API documentation!


Time to complete: ~5 minutes Next: Installation Guide