Skip to content

Latest commit

 

History

History
50 lines (34 loc) · 1.33 KB

README.md

File metadata and controls

50 lines (34 loc) · 1.33 KB

cloakdocs-web-app

This project is a web application built using Streamlit that allows users to upload images, draw masks on them, and download masked images. The application supports common image formats like JPG, JPEG, and PNG.

🚀 Features

  • Upload images (JPG, JPEG, PNG)
  • Draw masks directly on the uploaded images
  • Customize the mask color and opacity
  • Download the masked image
  • Responsive design that works on desktop and mobile
  • Coming soon: PDF support and additional masking features

🖥 Demo

Recorded Demo: YouTube Link

You can access the live application here, just working out a few kinks at the moment: Live Demo

💻 Local Setup and Installation

Follow these instructions to run the project on your local machine.

Prerequisites

Make sure you have the following installed on your system:

  • Python 3.x
  • pip (Python package manager)

Installation Steps

  1. Clone the repository:

    git clone https://github.com/meghna-cse/cloakdocs-web-app.git
cd cloakdocs-web-app

  2. Install the required dependencies: *If you want to setup a virtual environment do it before this step.

pip install -r requirements.txt
  1. Run the Streamlit app:
streamlit run app.py
  1. Access the app at http://localhost:8501.