https://github.com/specy/scapix

An image upscaling and denoiser app
https://github.com/specy/scapix

ai denoise electron electron-app ffmpeg hacktoberfest javascript machine-learning svelte upscale

Last synced: 6 days ago
JSON representation

An image upscaling and denoiser app

• Host: GitHub
• URL: https://github.com/specy/scapix
• Owner: Specy
• Created: 2021-01-03T10:48:02.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-07-27T14:52:34.000Z (over 1 year ago)
• Last Synced: 2024-08-02T16:11:20.287Z (5 months ago)
• Topics: ai, denoise, electron, electron-app, ffmpeg, hacktoberfest, javascript, machine-learning, svelte, upscale
• Language: TypeScript
• Homepage:
• Size: 123 MB
• Stars: 161
• Watchers: 6
• Forks: 12
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Downloads](https://img.shields.io/github/downloads/Specy-wot/Scapix/total.svg?style=for-the-badge)](https://github.com/Specy-wot/Scapix/releases)

# Welcome to Scapix

Scapix is an app developed with sveltekit, electron, waifu2x and esrgan.

It's made to denoise/upscale images, gifs, videos locally on your computer.

![Preview image](./docs/screenshot.png)

# Installation

## Windows 

Simply download the latest release from the [releases page](https://github.com/Specy/Scapix/releases/latest), download the installer and run it.

## Other OS

Currently the app is not pre bundled for other OSses but it should be possible to compile it manually, this will take +-10 minutes, look for the [building section](#building) for more info.

# Usage

Once ran the app, you can import images to upload, set the different options and click on the `run all` button to upscale all the images at once, or individually on each image by pressing the play button.

You can apply global settings that will be used as the default if specific ones aren't set, but you can also override those in each image individually.

For more info, check the info page in the app.

# Donate

If you like this app and the work i do, please consider donating to support the development, through [ko-fi](https://ko-fi.com/specy) or [paypal](https://paypal.me/specyDev)

# Building

Once cloned the repo, install the dependencies with `npm run installDeps` command, this will install the dependencies for both electron and the client

Afterwards, you can run `npm run build` or `npm run build:debug` to build the app, the debug version will show some additional logs in the console.

# Local development

To run the app locally in dev mode, install the dependencies with `npm run installDeps` and in one terminal run `npm run dev:electron` and in another `npm run dev:client` to start the electron app and the client respectively. Whenever you make changes to the electron, you must restart the server (to improve). The client will hot reload on changes.

# Credits 

[Waifu2x module](https://github.com/Tenpi/waifu2x)

[Waifu2x Models](https://github.com/nagadomi/waifu2x)

[ffmpeg](https://github.com/FFmpeg/FFmpeg)