Skip to content

README.md

Latest commit

 

History

History
345 lines (277 loc) · 7.59 KB

README.md

File metadata and controls

345 lines (277 loc) · 7.59 KB

Live Better Backend

REST API for Live Better productivity application.

Main documentation: See ../README.md for project overview and setup.

Quick Start

# Install dependencies
bun install

# Setup environment
touch .env  # Then edit with your credentials (DATABASE_URL, JWT_SECRET, OPENAI_API_KEY)

# Create PostgreSQL database
podman run --name livebetter-postgres \
-e POSTGRES_USER=livebetter \
-e POSTGRES_PASSWORD=livebetter \
-e POSTGRES_DB=livebetter \
-p 5432:5432 \
-d postgres:17

# Setup database schema
bunx drizzle-kit generate  # Generate migrations
bunx drizzle-kit migrate   # Apply migrations

# Run server
bun run dev  # http://localhost:3000

⚠️ Before starting: Make sure to:

  1. Create the PostgreSQL database (live_better)
  2. Update .env with your actual database credentials
  3. Set a secure JWT_SECRET (min 32 characters)
  4. Get your OpenAI API key from platform.openai.com/api-keys

Testing

# Run all tests
bun test

# Coverage report
bun test --coverage

# Watch mode
bun test --watch

# Specific tests
bun test src/services/ai.test.ts

Coverage: 375 tests (100% pass rate), 82% line coverage, 80% function coverage

Docker

Image: leaaboujaoude/livebetter-backend:latest

# Build
docker build -t leaaboujaoude/livebetter-backend:latest .

# Run
docker run -p 3000:3000 \
  -e DATABASE_URL="postgresql://..." \
  -e JWT_SECRET="..." \
  -e OPENAI_API_KEY="sk-..." \
  leaaboujaoude/livebetter-backend:latest

Azure: Migrations run automatically on container start.

API Reference

Base URL: http://localhost:3000/api

Authentication

Register

curl -X POST http://localhost:3000/api/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"pass123","name":"John"}'

Login

curl -X POST http://localhost:3000/api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"user@example.com","password":"pass123"}'

Get Profile (Protected)

curl -X GET http://localhost:3000/api/auth/profile \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Profile (Protected)

curl -X PUT http://localhost:3000/api/auth/profile \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"Jane","userContext":"I prefer mornings","preferredTimeSlots":["morning","night"]}'

Goals

Create Goal

curl -X POST http://localhost:3000/api/goals \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Learn TypeScript","description":"Master TS","targetDate":"2025-12-31"}'

Get All Goals

curl -X GET http://localhost:3000/api/goals \
  -H "Authorization: Bearer YOUR_TOKEN"

Get Single Goal

curl -X GET http://localhost:3000/api/goals/1 \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Goal

curl -X PUT http://localhost:3000/api/goals/1 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Master TypeScript","completed":false}'

Delete Goal

curl -X DELETE http://localhost:3000/api/goals/1 \
  -H "Authorization: Bearer YOUR_TOKEN"

Tasks

Create Task

curl -X POST http://localhost:3000/api/tasks \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"Study","timeSlot":"morning","duration":60,"goalId":1}'

Get Today's Tasks

curl -X GET http://localhost:3000/api/tasks \
  -H "Authorization: Bearer YOUR_TOKEN"

Get All Tasks

curl -X GET http://localhost:3000/api/tasks/all \
  -H "Authorization: Bearer YOUR_TOKEN"

Update Task

curl -X PUT http://localhost:3000/api/tasks/1 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"completed":true}'

Delete Task

curl -X DELETE http://localhost:3000/api/tasks/1 \
  -H "Authorization: Bearer YOUR_TOKEN"

Validate with Photo

curl -X POST http://localhost:3000/api/tasks/1/validate-photo \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"photoUrl":"https://example.com/photo.jpg"}'

AI

Generate Daily Schedule

curl -X POST http://localhost:3000/api/goals/tasks/ai-create-all \
  -H "Authorization: Bearer YOUR_TOKEN"

Response:

{
  "tasks": [
    {
      "id": 1,
      "title": "Morning study session",
      "timeSlot": "morning",
      "duration": 60,
      "goalId": 1,
      "aiGenerated": true
    }
  ],
  "reasoning": "Scheduled based on your morning preference"
}

Check AI Daily Limit

curl -X GET http://localhost:3000/api/goals/tasks/daily-limit-check \
  -H "Authorization: Bearer YOUR_TOKEN"

Database Schema

Users Table

{
  id: serial
  email: varchar(255) unique
  password: varchar(255)
  name: varchar(255)
  userContext: text
  preferredTimeSlots: varchar
  createdAt: timestamp
  aiGenerationsToday: integer
  lastAiGenerationDate: date
}

Goals Table

{
  id: serial
  userId: integer → users.id
  title: varchar(255)
  description: text
  targetDate: date
  completed: boolean
  createdAt: timestamp
}

Tasks Table

{
  id: serial
  userId: integer → users.id
  goalId: integer → goals.id
  title: varchar(255)
  description: text
  timeSlot: varchar(50)
  specificTime: timestamp
  duration: integer
  completed: boolean
  aiGenerated: boolean
  photoUrl: varchar(500)
  createdAt: timestamp
}

Tech Stack

  • Runtime: Bun 1.2.21
  • Framework: Hono 4.9.6
  • Database: PostgreSQL + Drizzle ORM
  • Auth: JWT + bcryptjs
  • Validation: Zod
  • AI: OpenAI GPT-4
  • Testing: Bun Test

Environment Variables

# Database
DATABASE_URL=postgresql://user:pass@localhost:5432/live_better

# Authentication (min 32 chars)
JWT_SECRET=your-super-secret-jwt-key-min-32-chars

# AI Service
OPENAI_API_KEY=sk-your-openai-api-key

Test Coverage

File Functions Lines Tests
utils/time.ts 100% 100% 45
utils/auth.ts 100% 95.65% 38
middleware/auth.ts 100% 100% 25
services/ai.ts 93.33% 100% 18
routes/auth.ts 100% 92.05% 52
routes/goals.ts 70.83% 65.99% 79
routes/tasks.ts 100% 68.24% 69
services/photoValidation.ts 25% 6.19% 6
utils/validation.ts 20% 38.89% 49
Overall 79.55% 82.08% 375

Test Infrastructure

The test suite includes comprehensive coverage with:

  • Unit tests for utilities and services
  • Integration tests for API endpoints with real database
  • Authentication tests for JWT and bcrypt
  • Validation tests for input sanitization
  • AI service tests with mocked OpenAI responses

All tests use an isolated test database and include proper setup/teardown.

Coverage Improvements:

  • Auth middleware: 100%
  • Time utilities: 100%
  • Auth utilities: 95.65%
  • Core routes: 68-92%

See commit 47ee9b1 for full details.

Common Issues

Port Already in Use

lsof -ti:3000 | xargs kill -9

JWT Token Invalid

  • Ensure JWT_SECRET is at least 32 characters
  • Check token hasn't expired (7-day limit)
  • Verify Authorization: Bearer TOKEN format

OpenAI API Error

  • Verify OPENAI_API_KEY is valid
  • Check quota at platform.openai.com
  • Ensure internet connection

Additional Resources