Skip to content

franklinnolasco7/Vivant

Vivant logo

Read More. Live More. Vivant.

A native Tauri e-reader for Linux.

License Platform Status


Requirements

Tool Version
Node.js 18+
npm 9+
Rust stable
WebKitGTK 6.0 dev packages

Install system dependencies for your distro:

# Arch
sudo pacman -S rustup nodejs npm webkitgtk-6.0 base-devel

# Fedora
sudo dnf install rust cargo nodejs npm webkitgtk6.0-devel

# Debian / Ubuntu
sudo apt install rustup nodejs npm libwebkitgtk-6.0-dev

rustup toolchain install stable
rustup default stable

Quick Start

Option 1: Local setup

git clone https://github.com/franklinnolasco7/Vivant.git
cd Vivant
npm install
npm run tauri dev

Option 2: Docker (optional)

Docker is optional and provided for contributors who prefer a consistent, containerized development environment.

git clone https://github.com/franklinnolasco7/Vivant.git
cd Vivant
./scripts/docker-shell.sh

For full Docker usage, see DOCKER.md.


Contributing

Read CONTRIBUTING.md before PR. Project follows strict rules (GPL-3.0, parameterized SQL, no telemetry).


Scripts

Command Description
npm run dev Start the frontend dev server
npm run build Build the frontend for production
npm run test Run the test suite
npm run tauri dev Launch the full Tauri app in dev mode
npm run tauri build Build a production Tauri binary

Data

Vivant stores your library database at:

~/.local/share/dev.vivant.reader/vivant.db

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

About

Read more. Live more.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors