Skip to content

Latest commit

 

History

History
115 lines (80 loc) · 3.51 KB

README.md

File metadata and controls

115 lines (80 loc) · 3.51 KB

Swift Forms

Fill your Google Forms swiftly! ✨

Swift Forms is a project that leverages machine learning to enhance the Google Forms experience. By using a FastAPI backend with Python and a Chrome extension for the frontend, this tool allows users to quickly fill out Google Forms. 📝

🌟 Features

  • FastAPI Backend: Powered by Python 3.12.7, the backend utilizes machine learning models for answering questions.
  • Chrome Extension: A lightweight frontend component to integrate with Google Forms directly in the browser.
  • ML-Driven Responses: Swiftly generate answers for form questions using intelligent algorithms. 🤖

⚙️ Backend Setup

Python Installation

  1. Clone the repository:

    git clone https://github.com/sahilsh-dev/Swift-Forms.git
cd Swift-Forms/backend

  2. Install dependencies:

    uv (recommended)

    You can install uv from here

    uv sync

source .venv/bin/activate  # For Unix/MacOS
.venv\Scripts\activate   # For Windows
    pip Make sure you have python 3.12 installed 
    python3 -m venv .venv
source .venv/bin/activate  # For Unix/MacOS
.venv\Scripts\activate   # For Windows

pip install -r requirements.txt

  3. Run the backend server:

    fastapi dev app.py

    The server should now be running at http://127.0.0.1:8000

Docker Installation 🐳

  1. Install Docker:
    Follow the official Docker installation guide for your operating system.

  2. Build the Docker Image:
    Run the following command to build the Docker image:

    docker build -t swiftforms-server .

  3. Run the Docker Container:
    Use the following command to start the container:

    docker run -v hf-models:/cache/huggingface -p 8000:8000 -it swiftforms-server

  4. Access the Application:
    Open your browser and navigate to http://localhost:8000

Note

For Windows Users 🪟

  • Ensure that Docker Desktop is installed and running.
  • If you need to map a specific directory to the container (instead of using a named volume), use the Windows-style absolute path for the -v flag:
docker run -v C:\path\to\cache:/cache/huggingface -p 8000:8000 -it swiftforms-server

💻 Frontend Setup

  1. Navigate to the frontend folder in the project directory.
  2. Open Google Chrome and navigate to chrome://extensions.
  3. Enable Developer mode (toggle in the top right).
  4. Click Load unpacked and select the frontend folder.
  5. The Chrome extension should now be loaded and ready to use. 🎉
  6. Click the extension to open a sidepanel and fill the knowlege base based on which questions will be answered.

📖 Usage

  1. Launch the FastAPI backend as described above.
  2. Open your browser and ensure the Swift Forms extension is active.
  3. Navigate to a Google Form, and click on Fill answers in the extension sidepanel.

🤝 Contributing

We welcome contributions to Swift Forms! To contribute:

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Submit a pull request with a detailed description of your changes.

📬 Contact

For any questions or support, you can contact me.

Enjoy using Swift Forms to make your Google Forms experience seamless! 🚀