pixel-scaler

(β˜… 250)

A pixel art upscaling tool

  • .env
  • .env.standalone
  • .gitignore
  • AGENTS.md
  • bun.lock
  • CODE_OF_CONDUCT.md
  • eslint.config.ts
  • index.html
  • LICENSE
  • mise.toml
  • package.json
  • playwright.config.ts
  • README.md
  • tsconfig.app.json
  • tsconfig.json
  • tsconfig.node.json
  • tsconfig.vitest.json
  • vite.config.ts
  • vitest.config.ts

# Installation Guide

1. Get the code
git clone https://github.com/irokaru/pixel-scaler

Downloads the entire project code from GitHub to your computer.

cd pixel-scaler

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Rust (rustup) Rust is required to use cargo.
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
cargo install tauri-cli

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

sudo apt install -y libwebkit2gtk-4.1-dev build-essential curl wget file libxdo-dev libssl-dev libayatana-appindicator3-dev librsvg2-dev

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Rust

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Rust (rustup) Installing via rustup also installs cargo.
cargo install tauri-cli

Builds and installs the package published on crates.io β€” no need to clone the repo yourself.

βœ… If cargo build finishes without errors, it worked. The executable is created under target/.

Pulled directly from this repo's README.

// repository documentation