The most powerful form builder for any site.

• Features
• Project Structure
• Getting Started
• Usage
• Contributing
  • Pull Requests
• License

• Create usable forms in seconds

• Hosted forms for static sites

• Form UI templates

• Send email notifications, connect webhooks, & integrate with CRMs

• Custom field validation, bot protection, and file upload/storage

• Cooler features

  • Multi-step forms
  • Form success & redirects
  • Editable email templates
  • Cookies & UTM tracking
  • Exportable data
  • React SDK for form templates & validation (future)

• frontend - Next.js app
• api - Workers API
• packages/* - Shared packages
  • types/* - Shared types
  • ui/* - UI components
  • templates/* - UI templates
  • utils/* - Shared utilities
• cli - CLI for managing Formscale
• react - React SDK

1. Clone repository:

git clone https://github.com/Formscale/formscale.git

2. Install dependencies:

pnpm install

3. Generate Prisma client:

pnpm generate

4. Build packages:

pnpm build

5. Start development servers:

pnpm dev

6. Configure environment:

• Add your own bucket and database from Cloudflare to api/wrangler.toml.
• Add your own Resend API key and JWT secret to api/.dev.vars.example and rename it to .dev.vars.

WIP

Contributions are welcome! Please feel free to open an issue or submit a pull request.

DM on Discord for questions (dris404).

Planning to launch end of Feb 2025?

1. Create a feature branch:

git checkout -b feature/new-feature

2. Make changes and commit:

git commit -m "feat: added new feature"
git commit -m "fix: fixed bug with..."
git commit -m "docs: updated readme"

3. Run checks before pushing:

pnpm lint        # lint
pnpm build       # see if it builds
pnpm test        # run tests

4. Push and create PR:

git push origin feature/new-feature

This project is licensed under the MIT License - see the LICENSE file for details.