The volery from elliotwutingfeng

elliotwutingfeng / volery Goto Github PK

View Code? Open in Web Editor NEW

Volery is a time-saving package batch installation script generator for Arch Linux or Arch-Based distro users. Package lists from the Arch Linux Official Repository and the Arch User Repository (AUR) are updated once per hour.

License: Apache License 2.0

JavaScript 43.55% Python 44.15% CSS 6.20% PLpgSQL 6.09%

volery's Introduction

Volery

How to use Volery

🔍 Search for your favourite packages.
📋 Copy the batch installation script to your clipboard.
💻 Voilà! Now paste it into your terminal and install your packages!

How Volery works

Using GitHub Actions + Python & Supabase API, package lists from the Arch Linux Official Repository and the Arch User Repository (AUR) are mirrored to a PostgreSQL database hosted on Supabase, once per hour.
For Arch Official Repositories metadata, the official repositories web interface is used.
For the Arch User Repository (AUR) metadata, the AUR metadata archives is used to minimise Volery's impact on AUR traffic.
A NextJS web user interface lets users query the database for Arch Official Repositories packages and AUR packages, pick and choose their favourite packages, and generate a yay script for convenient batch-installation.

Setup instructions

git clone and cd into the project directory

Supabase Setup

Create a free Supabase account and project, and run the SQL scripts create_arch_official_repo.sql and create_aur.sql from your Supabase project dashboard.

Declare environment variables

cp .env-dev .env.local

In .env.local, fill in the following variables

# You will need a free Supabase account and project (https://supabase.com)
NEXT_PUBLIC_SUPABASE_URL=
NEXT_PUBLIC_SUPABASE_ANON_KEY=

Install dependencies

yarn install

Run in development mode

yarn run dev

Inspiration

Volery was inspired by Ninite, a package management system for Windows. "Volery" was the codename of Ninite during its private beta stage, and Ninite used to support Linux in the past.