Getting Started

Prerequisites

  • Node.js 22+ - Download from nodejs.org

  • PowerShell 5.1+ (comes with Windows 10/11)

  • Administrator privileges (for initial setup)

  • Sign up for a Square Developer account

  • Sign up for a Radar SDK account

  • Sign up for a Convex account

Quick Start (Recommended)

We provide scripts to simplify the setup process:

1. Clone the repository

git clone <repo_url>
cd ftn-site-vercel/ftn-nextjs

2. Run the setup script

Windows:

.\setup.ps1

macOS/Linux:

./setup.sh

This will:

  • Check prerequisites (Node.js, pnpm)

  • Build the setup GUI application

  • Launch the cross-platform setup wizard

  • Guide you through the complete setup process

3. Configure environment variables

  • Environment variables are stored in .env and .env.local. Copy the template files (.env.example or .env.local.example)

  • Populate .env.local with your personal API keys.

  • See Environment Variables for details

4. Start Convex dev server

Start Convex dev server (in separate terminal, from ftn-nextjs directory):

cd ftn-nextjs
npx convex dev

5. Start the development server

cd ftn-nextjs
.\run.ps1

6. Open your browser

Available Scripts

  • setup.ps1 - Initial setup and dependency installation

  • run.ps1 - Start development server, build, lint, format

  • setup-gui/ - Desktop GUI application for visual setup

For detailed script usage, see PowerShell Scripts.

GUI Setup (Recommended)

For a visual setup experience, you can use the included desktop application:

1. Navigate to the GUI directory

cd setup-gui

2. Install dependencies

pnpm install

3. Run the GUI

.\run-dev.ps1

The GUI provides a step-by-step wizard for project setup with visual feedback and error handling.

Manual Setup

If you prefer manual setup or encounter issues with the scripts, see Manual Setup for step-by-step instructions.