Vesktop

(β˜… 8,322)

Vesktop is a custom Discord App aiming to give you better performance and improve linux support

  • .env.example
  • .gitignore
  • .prettierrc.yaml
  • eslint.config.mjs
  • LICENSE
  • package.json
  • pnpm-lock.yaml
  • pnpm-workspace.yaml
  • README.md
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/Vencord/Vesktop

Downloads the entire project code from GitHub to your computer.

cd Vesktop

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
docker build -f packages/libvesktop/Dockerfile -t vesktop .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 vesktop

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

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.
pnpm i

Type this command into your terminal and run it.

pnpm start

Starts the development/run server.

pnpm package

Type this command into your terminal and run it.

pnpm package --linux pacman

Type this command into your terminal and run it.

pnpm package:dir

Type this command into your terminal and run it.

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

Pulled directly from this repo's README.

// repository documentation