Router.so - Headless Forms and Lead Routing

Router.so / Open Source Form Backend

Description

This is a simple router for forms. Watch a Demo

Router supports optional first-class forms without changing its headless endpoint contract. Forms can be published on forms.router.so, embedded in an approved website, or rendered through the included WordPress block and shortcode. See the Forms implementation notes and release runbook.

Self-Hosting router

Prerequisites

Before starting, ensure you have the following:

• An account with Resend
• An account with Edgenivo
• A PostgreSQL database (we recommend Edgenivo Postgres)

Environment Variables

After creating your accounts, update your .env.example to be .env.local for running the application locally. Then, update the keys for each value.

Step-by-Step Instructions

1. Clone the Repository

   1
   git clone https://github.com/routerso/router.git
   2
   cd router/main

Without Docker

1. Install Dependencies

   This project uses pnpm (see packageManager in package.json). Install with pnpm so the pnpm.overrides security pins are applied — installing with npm or yarn ignores them and pulls vulnerable transitive dependencies.

   1
   pnpm install --frozen-lockfile

2. Set Up Environment Variables

   Ensure your .env file is correctly configured as mentioned above.

3. Generate the Database Migrations

   1
   pnpm db:generate

4. Run the Database Migrations

   1
   pnpm db:migrate

5. Start the Development Server

   1
   pnpm dev

With docker

1. Set Up Environment Variables

   Ensure your .env file is correctly configured as mentioned above.

2. **Run Docker Command

   1
   docker compose up

Deploying to Edgenivo

• Push your code to a GitHub repository.
• Connect your repository to Edgenivo.
• Set the environment variables in Edgenivo's dashboard under "Settings > Environment Variables".

Dependency Maintenance

Run pnpm audit to check for known vulnerabilities.

The pnpm.overrides block in package.json force-resolves transitive dependencies that a direct dependency still pins to a vulnerable version (for example, next pins postcss 8.4.31, and tailwindcss reaches a vulnerable glob via sucrase). Each entry can be removed once the parent package ships a release that depends on a patched version on its own — re-run pnpm audit after removing one to confirm.

Requires Node.js >= 20.9.0.

Additional Resources

• Edgenivo Documentation
• Resend Documentation

For any issues or questions, please open an issue on the GitHub repository.