Formiq

Formiq is a robust, open-source form management solution designed for modern web applications. It provides a complete infrastructure for handling form submissions, including a secure API server, a developer-friendly SDK, and background workers for asynchronous processing.

🚀 Key Features

• Secure Form Handling: End-to-end encryption for sensitive data and secure API key management.
• Multi-Project Support: Manage multiple projects (forms) from a single dashboard.
• Asynchronous Processing: Offload heavy tasks like email notifications and webhooks to background workers using Redis and BullMQ.
• Developer SDK: Easy-to-use TypeScript SDK with React and Next.js hooks (useFormiq).
• Analytics: Track submission counts and trends.
• Spam Protection: Built-in rate limiting and validation.

🛠 Tech Stack

• Runtime: Bun (Fast JavaScript runtime)
• Language: TypeScript
• Framework: Express.js
• Database: MongoDB (Data persistence)
• Queue: BullMQ & Redis (Background jobs)
• Authentication: Better Auth
• Validation: Zod & Express Validator

📂 Components

• Server: The core API backend.
• SDK: Client-side libraries.
• Workers: Background job processors.
• Client: Frontend dashboard (Next.js).

📚 Documentation

Detailed documentation is available in the docs directory:

• Architecture: System design, data flow, and database schema.
• API Reference: Endpoints, request/response formats, and authentication.
• Setup Guide: Installation, configuration, and deployment instructions.
• Technical Decisions: Rationale behind technology choices.

Quick Start

1. Prerequisites: Ensure you have Bun, Docker, and Node.js installed.
2. Start Infrastructure: Run docker-compose up -d to start MongoDB and Redis.
3. Install Dependencies: Run bun install in the root directory (if using a monorepo workspace) or in each subdirectory.
4. Start Server: cd server && bun run dev
5. Start Workers: cd workers && bun run dev (or npm run dev)

License

MIT