Skip to content

README.md

Latest commit

 

History

History
117 lines (81 loc) · 2.58 KB

README.md

File metadata and controls

117 lines (81 loc) · 2.58 KB

F3 Nation Map Application

This is the F3 Nation Map application, an interactive map for F3 Nation locations and events.

Application Details

  • Port: 3000
  • Framework: Next.js
  • TypeScript: Yes
  • Testing: Playwright, Vitest

Setup

  1. Navigate to the monorepo root:

    cd f3-nation

  2. Install dependencies (if not already installed):

    pnpm install

  3. Environment setup:

    • Get env.zip from F3 Nation Slack
    • Unzip and rename to .env
    • Place the .env file in this directory (apps/map/.env)

  4. Database setup - Add the service account API key:

    Insert a row into the api_keys table in your database:

    INSERT INTO api_keys (key, name, description, owner_id)
VALUES ('f3_map_service_account', 'F3 Map Service Account', 'Provides Public Access', 1);

    This key enables unauthenticated access to the public map interface.

  5. Start development server:

    # From the monorepo root, start only the map app
pnpm dev --filter f3-nation-map

# Or navigate to the app directory and run directly
cd apps/map
pnpm dev

Environment Variables

Environment variables are application-specific in this monorepo. The .env file should be placed in the application directory (apps/map/) rather than the monorepo root.

Required environment variables (typically provided in env.zip):

  • Database connection strings
  • Authentication secrets
  • API keys
  • Application configuration

Development

Running Tests

# Run all tests for the map app
pnpm test --filter f3-nation-map

# Run specific test suites
cd apps/map
pnpm test:e2e  # Playwright end-to-end tests
pnpm test:unit # Vitest unit tests

Building for Production

# Build the map application
pnpm build --filter f3-nation-map

Linting

# Run linting for the map app
pnpm lint --filter f3-nation-map

Features

  • Interactive map interface
  • Location management
  • Event scheduling and display
  • User authentication
  • Responsive design

Architecture

This application is built with:

  • Next.js 14 with App Router
  • React with TypeScript
  • Tailwind CSS for styling
  • oRPC for type-safe API calls
  • Drizzle ORM for database operations
  • Playwright for end-to-end testing
  • Vitest for unit testing

Related Documentation