https://github.com/routerso/router
Router.so is headless form handling and lead routing for marketing-minded developers.
https://github.com/routerso/router
form-builder forms lead-router next-js open-source shadcn-ui tailwind
Last synced: about 1 month ago
JSON representation
Router.so is headless form handling and lead routing for marketing-minded developers.
- Host: GitHub
- URL: https://github.com/routerso/router
- Owner: routerso
- License: agpl-3.0
- Created: 2024-03-25T21:39:40.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-01T18:33:03.000Z (3 months ago)
- Last Synced: 2025-04-12T04:51:21.625Z (2 months ago)
- Topics: form-builder, forms, lead-router, next-js, open-source, shadcn-ui, tailwind
- Language: TypeScript
- Homepage: https://router.so
- Size: 6.23 MB
- Stars: 302
- Watchers: 4
- Forks: 51
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Router.so / Open Source Form Backend
## Description
This is a simple router for forms. [Watch a Demo](https://x.com/youngbloodcyb/status/1831808232966516972)
# Self-Hosting router
## Prerequisites
Before starting, ensure you have the following:
- An account with [Resend](https://resend.com/)
- An account with [Vercel](https://vercel.com/)
- A PostgreSQL database (we recommend [Vercel Postgres](https://vercel.com/docs/storage/vercel-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**
```sh
git clone https://github.com/routerso/router.git
cd router/main
```
### Without Docker
2. **Install Dependencies**
```sh
npm install
```
3. **Set Up Environment Variables**
Ensure your `.env` file is correctly configured as mentioned above.
4. **Generate the Database Migrations**
```sh
npm drizzle-kit generate
```
5. **Run the Database Migrations**
```sh
npm tsx lib/db/migrate.ts
```
6. **Start the Development Server**
```sh
npm run dev
```
### With docker
2. **Set Up Environment Variables**
Ensure your `.env` file is correctly configured as mentioned above.
3. **Run Docker Command
```sh
docker compose up
```
## Deploying to Vercel
- Push your code to a GitHub repository.
- Connect your repository to Vercel.
- Set the environment variables in Vercel's dashboard under "Settings > Environment Variables".
## Additional Resources
- [Vercel Documentation](https://vercel.com/docs)
- [Resend Documentation](https://resend.com/docs)
For any issues or questions, please open an issue on the [GitHub repository](https://github.com/routerso/router).