Running ForgeFX Tools

This guide will walk you through the process of running ForgeFX tools locally using Vercel Dev, which provides a development environment that closely mimics the Vercel production environment.

Prerequisites

• Node.js (v20 or later)
• Vercel CLI installed (npm i -g vercel)

Steps to Run Your Tool

1. Navigate to your tool’s directory

   Open a terminal and change to your tool’s root directory:

   cd path/to/your/tool

2. Install dependencies

   If you haven’t already, install the project dependencies:

   npm install

3. Set up environment variables

   Create a .env file in your project root and add necessary variables:

   KEY=VALUE
   

4. Start Vercel Dev server

   Run the following command to start the Vercel Dev server:

   vercel dev

   This command will:

   • Set up a local development environment
   • Build your project
   • Start a local server, typically at http://localhost:3000

5. Access your tool

   Open your web browser and navigate to http://localhost:3000 (or the URL provided in the terminal output).

Hot Reloading

Vercel Dev supports hot reloading. When you make changes to your code, the server will automatically rebuild and refresh your browser.

Vercel Configuration

Your tool should have a vercel.json file in its root directory. This file configures how Vercel deploys and runs your tool. Here’s a basic example: