Welcome to AskAtlas

AskAtlas is an all-in-one student workspace for planning, practice, and class collaboration.

Documentation Overview

Getting Started

• Prerequisites — Tools and dependencies you need installed
• API Setup — Running the Go backend locally
• Web Setup — Running the Next.js frontend locally
• Database Setup — Managing database migrations

Architecture

• System Overview — How all the pieces fit together
• Authentication Flow — Clerk integration on frontend and backend
• Clerk Setup — Configuring Clerk apps, webhooks, and keys
• Data Model: Users · Files

Infrastructure

• CI/CD Pipelines — PR checks, deployments, and rollbacks
• Deployment — Digital Ocean deploy and rollback process
• Environments — Dev, staging, and production configuration

Development

• API Patterns — Endpoint design and Go code conventions
• Frontend Patterns — Next.js page and component patterns
• Naming Conventions — Naming rules across the stack
• Database Migrations — Creating and managing schema changes
• Logging Patterns — Structured logging with slog
• Error Handling — AppError, sentinels, and error flow
• Testing — Unit and E2E testing strategy

API Reference

• Files — File listing and retrieval endpoints

Contributing

• Contributing Guide — Commits, PRs, and workflow
• Docs Guide — How to add and edit documentation

Sprint Reviews

• Sprint 1 — 01/26/26 – 03/01/26