Skip to content

Latest commit

 

History

History
140 lines (104 loc) · 5.78 KB

README.md

File metadata and controls

140 lines (104 loc) · 5.78 KB
Raw

SmartForms

Watchers Forks Stars Issues Open Pull Requests License

Overview

SmartForms is a modern form builder that simplifies the process of creating and managing interactive forms. Integrated with CopilotKit AI, it streamlines question generation and provides a dynamic response handling experience.

Key Features

  • AI-Powered Question Generation: Automatically generate multiple-choice questions using CopilotKit.
  • Interactive Response Handling: Sort and manage responses effectively with enhanced AI tools.
  • Shareable Forms: Easily share forms via generated links, allowing for quick and broad distribution.

Demo

SmartForms-demo.mp4

Teacher Point of View

  • Launching SmartForms: Teachers begin by opening the Landing page and clicking on "Launch SmartForms."
  • Creating a SmartForm: With the aid of CopilotKit, teachers create a SmartForm and submit it.
  • Sharing: A link for the SmartForm is generated and displayed, which the teacher can then share with students for completion.
  • Reviewing Responses: To review student responses, teachers navigate to http://localhost:5173/smartforms/responses. Here, they are required to enter the SmartForm ID and password to access and view the responses.

Student Point of View

  • Accessing the Form: Students start by opening the link provided by their teacher.
  • Entering Details: Students are prompted to input their name and continue to the SmartForm.
  • Completing the SmartForm: Students answer the questions provided in the SmartForm and submit their responses upon completion.

Installation

For installation instructions, please refer to the INSTALLATION.md file. Click here to navigate to it.

Usage

Get started by following these steps to set up both the frontend and backend for SmartForms.

Frontend Setup

  1. Navigate to the frontend directory: 
    cd frontend
  2. Install dependencies: 
    yarn
  3. Start the development server: 
    yarn run dev
    After starting the server, navigate to http://localhost:3000 to create and manage your forms.

Backend Setup

  1. Navigate to the backend directory: 
    cd backend
  2. Create a .env file in the root of the backend directory and add the following keys: 
    GOOGLE_API_KEY=<YOUR_GOOGLE_API_KEY>
MONGO_URI=mongodb://localhost:27017/quizApp
    Replace <YOUR_GOOGLE_API_KEY> with your actual Google API key.
  3. Install dependencies: 
    yarn
  4. Start the backend server: 
    yarn run start

Both servers need to be running concurrently for the application to function fully.

Screenshots

Click to view screenshots of SmartForms Interface

Creating Smart Form with Copilotkit Creating a Smart Form using CopilotKit: A step-by-step form building interface.

Landing Page Landing Page: The initial view of SmartForms, welcoming users.

Smart Form Responses Smart Form Responses: Viewing responses from users who have submitted forms.

SmartForm Created Successfully SmartForm Created Successfully: Confirmation screen after successfully creating a form.

User Taking Smart Form User Taking Smart Form: A user interacts with a form, showcasing the user-friendly interface.

Contributing

We welcome contributions! To contribute to SmartForms, please refer to the CONTRIBUTING.md file.

License

This project is licensed under the MIT License.

This project was created for Quira Quest 20: Hacktober Preptember

To explore Quira, visit: https://quira.sh/

Twitter post:

Click here for twitter post

Support Me! 🌟

  • Vote for me on Quira: Vote here!
  • Star my GitHub repo to show your support!