📋 QuickForms AI – Smart Form & Workflow Builder

Final Project – CSC 318: Software Engineering Principles
Student: Eric Amoh Adjei | Instructor: Prof. Rawad Habib
🗓️ August 2025

---

📌 Overview

QuickForms AI is an AI-powered form generator for individuals, teams, and small businesses.
It simplifies the creation of custom forms using natural language, auto-generates shareable links, collects responses, and exports data.

✨ Highlights:

• Create forms in minutes with AI assistance
• Share via public link
• Collect responses securely
• Export to CSV or Google Sheets

---

📚 Table of Contents

• 📋 QuickForms AI – Smart Form & Workflow Builder
  • 📌 Overview
    • ✨ Highlights:
  • 📚 Table of Contents
  • 🎥 Demo & Screenshots
  • 🚀 Features
  • 🏗️ Tech Stack
  • 📂 Project Structure
  • ⚙️ Getting Started
    • 1. Clone Repo
    • 2. Install Dependencies
    • 3. Set Up Environment
    • 4. Run Locally
  • 🧪 Testing
    • ✔ Coverage:
  • 📖 Documentation
  • 📦 Packaging
  • 🔮 Roadmap
  • 👥 Development Process
  • 🎓 Course Context
  • 🏆 Lessons Learned
  • 📜 License

---

🎥 Demo & Screenshots

• 🎬 YouTube Demo:
  • ✅ [YouTube Demo:
• PowerPoint Presentation:
  • ✅ [Presentation:
• 🖼️ Screenshots:
  • ✅ Form Builder UI
  • ✅ AI Generated Fields & Response Dashboard
  • ✅ CSV Export View Software Testing Passed Report

---

🚀 Features

• ✍️ AI-Prompted Form Generation
• 🔧 Form Components: Text, Dropdowns, Radios, Checkboxes, Dates
• 🌐 Shareable Links
• 📥 Submission Handling & CSV Export
• 📊 Google Sheets/Webhook Integration
• 📱 Responsive UI (React + Vite + Tailwind)
• 🔐 Data Storage: SQLite/Postgres via Prisma
• 🧪 Unit + Integration Testing Suite

---

🏗️ Tech Stack

Layer	Technology	Purpose
Frontend	React, Vite, TypeScript	Dynamic UI
Backend	Express, TypeScript	REST API + AI Integration
Database	Prisma ORM, SQLite/Postgres	Form/Response Persistence
Testing	Vitest, Supertest	Full coverage testing
Build	pnpm, PowerShell Scripts	Automation & Deployment

---

📂 Project Structure

quickforms-ai/
├── apps/
│   ├── web/       # Frontend (React)
│   └── api/       # Backend (Express)
├── prisma/        # DB Schema & Migrations
├── docs/          # UML, Reports, Manuals
│   ├── diagrams/
│   ├── reports/
│   └── user-manual/
├── tests/         # Unit + Integration Tests
├── README.md
└── package.json

---

⚙️ Getting Started

1. Clone Repo

git clone https://github.com/YOUR-USERNAME/quickforms-ai.git
cd quickforms-ai

2. Install Dependencies

cd apps/web && npm install       # Frontend
cd ../api && npm install         # Backend

3. Set Up Environment

Create .env in /apps/api/:

DATABASE_URL="file:./dev.db"
PORT=4000
OPENAI_API_KEY="your_api_key"

4. Run Locally

# Frontend
cd apps/web && npm run dev
# Backend
cd apps/api && npm run dev

• Frontend → http://localhost:5173
• Backend → http://localhost:4000

---

🧪 Testing

npm run test

✔ Coverage:

• ✅ Unit Tests – components & logic
• ✅ Integration Tests – API & flows
• ✅ System Tests – end-to-end form submission
• ✅ Manual Code Reviews

---

📖 Documentation

📘 File	Path
Final Report	/docs/final-report/FinalReport.md
Developer Guide	/docs/developer-guide/DeveloperGuide.md
User Manual	/docs/user-manual/UserManual.md
Testing Report	/docs/reports/TestingReport.md
Code Review Summary	/docs/code-review/CodeReview.md
UML Diagrams	/docs/diagrams
SRS (Requirements Spec)	/docs/Schema/Schema.md

---

📦 Packaging

.�ll-in-finals-build.ps1

This script packages the entire project into quickforms-ai-final.zip with all documentation and code.

---

🔮 Roadmap

• 🔐 User Authentication + Roles
• 📊 Analytics Dashboard for Form Insights
• 🧠 Advanced AI Prompt Suggestions
• ☁️ Production Deployment (Vercel + Render)

---

👥 Development Process

• 🌀 Agile Sprints – 2-week iterations
• 🔄 Unified Process (UP) – Full SDLC lifecycle
• 🔀 Git Workflow – Feature branches + PRs
• ✅ Peer Reviews – Before every merge

---

🎓 Course Context

Developed for CSC 318: Software Engineering Principles
Demonstrates:

• Requirements Engineering
• UML & Architecture Design
• Agile & Object-Oriented Programming
• Full Testing + Documentation
• Real-World Deployment-Ready MVP

---

🏆 Lessons Learned

• Mastered SDLC from planning to deployment
• Applied Agile + Unified Process collaboratively
• Designed layered MVC system
• Integrated OpenAI API & Google Sheets
• Built full documentation stack

---

📜 License

MIT License © 2025 – Eric Amoh Adjei
Free to use, modify, distribute.