Getting Started

Getting Started

This guide will help you set up and run Codex on your local machine.

Prerequisites

• Go 1.22 or higher
• SQLite3
• (Optional) Docker for containerized deployment

Installation

Clone the Repository

git clone https://github.com/gary-norman/forum.git
cd forum

Running Locally

Option 1: Using Make (Recommended)

The project includes an interactive menu system:

make menu

This displays options for:

• build - Build the application
• run - Run the application
• build-run - Build and run in sequence
• Docker - Docker management
• Scripts - Script management

Option 2: Direct Commands

# Build
make build

# Run
make run

# Build and run
make build-run

Option 3: Manual Go Commands

# Build
go build -o bin/codex github.com/gary-norman/forum/cmd/server

# Run
./bin/codex

Database Setup

Run Migrations

bin/codex migrate

Seed the Database

bin/codex seed

Docker Deployment

Configure Docker Settings

make configure

Build Docker Image

make build-image

Run Docker Container

make run-container

Accessing the Application

Once running, access the forum at:

http://localhost:8888

Next Steps

• Read the Architecture Overview
• Check the Development Guide
• Explore the Database Schema