# pal - Full Documentation

> Your AI companion

## Overview

pal. is a modern AI companion platform currently in development. This document provides comprehensive information about the project structure, technology stack, and features.

## About pal

pal. is designed to be your personal AI companion. The platform is currently in pre-launch phase with a launchlist for early access.

### Current Status
- Status: Coming Soon / Pre-Launch
- Early Access: Available via launchlist widget
- Website: https://usepal.ai

## Technology Stack

### Frontend (Client)
- **Framework**: Next.js 14 with App Router
- **UI Library**: React 18 with concurrent features
- **Language**: TypeScript for type-safe development
- **Styling**: TailwindCSS utility-first CSS framework
- **Runtime**: Bun - Fast all-in-one JavaScript runtime

### Backend (Server)
- Server-side rendering and static generation
- API routes for backend functionality
- RESTful API architecture

## Features

### Current Features
- Responsive landing page with mobile-first approach
- Launchlist integration for early access signups
- Server-side rendering for optimal performance
- SEO optimized structure
- Dark mode support

### Planned Features
- AI companion functionality
- User authentication and profiles
- Real-time chat interface
- Personalized AI interactions

## Project Structure

```
pal-website/
├── documentation/          # All project documentation and planning
│   ├── research/          # Technical research and analysis
│   ├── brainstorming/     # Initial ideas and planning
│   ├── specs/             # Formal specifications and designs
│   └── implementations/   # Implementation notes and retrospectives
├── scripts/               # Build scripts and automation tools
└── apps/                  # Application source code
    ├── client/           # Client-side code (frontend)
    │   ├── app/          # Next.js App Router pages
    │   ├── src/          # Source components and utilities
    │   └── public/       # Static assets
    └── server/           # Server-side code (backend)
```

## Development

### Workflow
1. Development happens on feature branches
2. Merge to staging for testing
3. Pull request from staging to main for production releases

### Branch Protection
- **main**: PR-only, requires review, no force push
- **staging**: Direct push allowed, no force push

### Deployment
- Automated deployment via GitHub Actions
- Cloudflare Pages for hosting
- Continuous deployment from staging branch

## API and Integration

### Launchlist Widget
The site integrates a launchlist widget for collecting early access signups:
- Widget Key: Ah728J
- Height: 180px
- Implementation: Client-side JavaScript widget

## Workflow Orchestration

### Prefect Deployments
The project uses Prefect for workflow orchestration with the following deployments:

#### SDLC Production
Full software development lifecycle workflow including classification, planning, implementation, documentation, commit, and PR creation.

#### Patch Production
Quick patch workflow for minor updates and fixes.

#### Research Production
Research and document best practices from external projects.

### Configuration
- **Work Pool**: standard-pool
- **Prefect Server**: http://agents-mac-mini.tail5de718.ts.net:4200/api
- **Repository**: git@github.com:willwnekowicz/pal-website.git
- **Branch**: staging

## Resources

### Links
- Website: https://usepal.ai
- Repository: https://github.com/willwnekowicz/pal-website
- Concise Info: /llms.txt

### Documentation
- README: Comprehensive setup and deployment guide
- Project structure: Organized documentation hierarchy
- API documentation: Coming soon

## Contact and Support

For questions, feedback, or early access inquiries, please sign up through the launchlist widget on the website.

---

Last Updated: November 2025