Skip to content

Nandgopal-R/form-engine

Repository files navigation

FormEngine

FormEngine is a college-focused web platform designed to simplify the creation and management of digital forms for academic and administrative purposes. It allows faculty, student coordinators, and departments to build customizable forms using an intuitive drag-and-drop interface, without requiring technical knowledge.

The platform helps colleges efficiently collect data for use cases such as event registrations, student feedback, surveys, and internal requests, while ensuring accurate and reliable submissions.


Features

  • Support for multiple field types
  • Built-in validation rules for accurate data collection
  • Real-time form preview before publishing
  • Secure form publishing with shareable links
  • Draft saving and resume support for form responders
  • Structured response collection for easy analysis
  • Designed specifically for college workflows

Visuals

Architecture Diagram

Architecture Diagram

Activity Diagram

Activity Diagram

Class Diagram

Class Diagram

Use Case Diagram

Use Case Diagram

Time Sequence Diagram

Time Sequence Diaram


Getting Started

Prerequisites

  • Bun (latest version)
  • Docker (for running the database)

Installation

  1. Clone the repository:

    git clone <https://github.com/Nandgopal-R/form-engine.git>
    cd form-engine
  2. Install dependencies:

    bun install
  3. Set up the environment variables:

    • Copy .env.example to .env and fill in with your secret keys.
  4. Start the database:

    docker-compose up -d
  5. Run database migrations:

    bunx prisma migrate dev

Development Scripts

  • bun run dev: Start the development server with hot-reloading.
  • bun run check: Run Biome for linting and formatting checks.
  • bun run typecheck: Run TypeScript type checking.
  • bun run build: Build the application for production.

Project Structure

  • src/: Backend source code.
  • prisma/: Database schema and migrations.
  • bruno/: Bruno API collection for testing endpoints.
  • dist/: Production build output.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5