Remove Background Svetle + Flask App
Overview
This project provides a web application for removing backgrounds from images using RemBG. The application is structured into two main components: a Flask-based backend and a Svelte + TypeScript frontend.
Features
- Background removal using the RemBG tool.
- User-friendly web interface for uploading and processing images.
Installation and Setup
Backend
- Clone the repository.
- Navigate to the
backend
directory.
- Install required dependencies:
pip install -r requirements.txt
.
- Start the Flask app:
python app.py
.
- The backend service will be available at
http://localhost:5100
.
Frontend
- Navigate to the
frontend
directory.
- Install dependencies using
npm install
.
- Start the frontend application with
npm run dev
.
- Access the web interface at the provided local URL.
Docker Compose Installation and Setup
Using Docker Compose, you can easily set up and run the entire application in Docker containers. This ensures a consistent and isolated environment regardless of the host system.
Prerequisites
- Docker installed on your system.
- Docker Compose installed on your system.
Steps to Run
- Clone the Repository:
Clone the remove-background-svelte-flask
repository to your local machine.
git clone https://github.com/malewicz1337/remove-background-svelte-flask.git
- Navigate to the Project Directory:
Change into the project's root directory where the docker-compose.yaml file is located.
cd remove-background-svelte-flask
- Build and Run with Docker Compose:
Use Docker Compose to build and start the services defined in docker-compose.yaml.
docker-compose up --build
How to Use
- After starting both the backend and frontend, open the web interface in a browser.
- Drag and drop an image or click to upload an image file.
- The processed image with the background removed will be available for download.
Contributing
Contributions to the project are welcome! Please follow the standard procedures for contributing to open-source projects on GitHub.
License
This project is open source and available under the MIT License.