Skip to content

A GenAI solution making whiteboards better than ever.

Notifications You must be signed in to change notification settings

krishnaGauss/FactorBoard

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

FactorBoard

A GenAI solution making whiteboards better than ever. Factorio is an AI based whiteboard that helps web users to unleash the power of Notes APP on iPads. This whiteboard app recognises what the user draws and gives the required output to the user.

Taking Help From

Table of Contents

Project Overview

Key Features

  • AI-Driven Handwriting Recognition: Converts user-drawn text and diagrams into machine-readable formats.
  • Real-Time Output Generation: Processes handwritten input and generates relevant outputs instantly.
  • Interactive User Interface: Provides a user-friendly whiteboard environment for seamless interaction.
  • Multi-Device Compatibility: Accessible on various platforms, enabling easy collaboration and usage across devices.

Technologies Used

  • React: Frontend framework for building the user interface.
  • Python & FastAPI: For GeminiAPI integration and fine tuning on Gemini model.
  • Axios: HTTP client for making API requests.
  • Tailwind CSS & shadcn: Utility-first CSS framework and components for building a responsive and consistent UI.

Prototype Video

Prototype Video

Prototype Image

Installation

Clone the Repository

git clone https://github.com/krishnaGauss/FactorBoard.git

Install Dependencies

  • Install Frontend Dependencies: In project root directory;
cd frontend
npm i
  • Install Backend Dependencies: In project root directory;
cd backend
python -m venv myenv
myenv/Scripts/activate
pip install -r requirements.txt

Creating .env files

  • In frontend directory setup a .env file with the following attributes;
VITE_API_URL = <Your VITE_API_URL>/Backend Server URL
  • In backend directory setup a .env file with the following attributes;
GEMINI_API_KEY=<YOUR KEY>

Running the Application

Running Frontend

In root directory;

cd frontend
npm run dev

Running Backend

In root directory;

cd backend
myenv/Scripts/activate
python main.py

License

MIT License

Copyright (c) 2024 Krishna Goswami

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

A GenAI solution making whiteboards better than ever.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published