adrianbonpin/deckyvault
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs: overhaul README with architecture overview, badges, and complete setup guide

Browse Source
This commit is contained in:
adrianbonpin
2026-04-29 12:59:42 +08:00
parent c54e332a9e
commit b435712b9c
1 changed files with 193 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+193 -63
View File
@@ -1,116 +1,246 @@
<div align="center">
# DeckyVault # DeckyVault
An open-source, community-driven database for Steam Deck (OLED & LCD) and Steam Machine compatibility, performance metrics, and settings. **The community-driven database for Steam Deck performance data, settings, and compatibility.**
> **Note:** DeckyVault is currently under active development. The site is live at [deckyvault.xyz](https://deckyvault.xyz) but features are being built incrementally. Stay tuned! [![Live Site](https://img.shields.io/badge/Live-deckyvault.xyz-eb3779?style=flat-square)](https://deckyvault.xyz)
[![Next.js](https://img.shields.io/badge/Next.js-16-black?style=flat-square&logo=next.js)](https://nextjs.org)
[![TypeScript](https://img.shields.io/badge/TypeScript-5-blue?style=flat-square&logo=typescript)](https://www.typescriptlang.org)
[![License](https://img.shields.io/badge/License-MIT-green?style=flat-square)](#license)
## Why DeckyVault? </div>
Gaming on the Steam Deck is incredible, but finding reliable, detailed answers about whether a game will run well — or how to optimize it — can be frustrating. Existing resources are often fragmented, outdated, or lack the depth the community needs. ---
**DeckyVault** aims to solve this by being the definitive, community-first hub for Steam Deck performance data. DeckyVault is an open-source platform where the Steam Deck community shares real-world performance benchmarks, optimized game settings, and compatibility reports. Every data point comes from actual players — not spec sheets.
> **Actively developed.** The site is live at [deckyvault.xyz](https://deckyvault.xyz). Features ship incrementally.
## Features ## Features
- **Community-First Contributions** — Built by the community, for the community. Anyone can contribute data and improvements. ### Performance Data
- **Streamlined Filters & Searching** — Quickly find the games you're looking for with powerful search and filtering. - **Community FPS metrics** — low / average / high benchmarks from real players
- **Rich Performance Metrics** - **Extended FPS tracking** — FSR, Frame Generation, and upscaling-specific metrics
- Community average FPS (**low**, **avg**, **high**). - **Historical graphs** — track performance across game versions, Proton builds, and SteamOS releases
- Extended FPS metrics for technologies like **FSR** and **Frame Generation**.
- **Beautifully Formatted Settings** — No more endless single-column lists. Every game features **sectioned setting tables** that mirror in-game menus. ### Game Settings
- **Historical FPS Graphs** — Track performance improvements over time across: - **Sectioned settings tables** — organized to mirror in-game menus, not flat lists
- Game Versions - **Per-device presets** — separate optimized settings for Steam Deck OLED, LCD, and Steam Machine
- Proton / Native builds - **One-click presets** — apply community-verified settings instantly
- SteamOS Versions
- **Multi-Device Support** — Dedicated metrics and optimized settings for **Steam Deck OLED**, **Steam Deck LCD**, and **Steam Machine**, all on a single page with quick toggles. ### Compatibility
- **Comprehensive Compatibility Tracking** - **Proton vs. Native status** — know before you launch
- Proton vs. Native status - **Online Play & Anti-Cheat tracking** — see which multiplayer games actually work
- Online Play & Anti-Cheat status - **Playable tags** — straightforward compatibility labels
- Straightforward "Playable" tags
- **Loading & Storage Metrics** — Track initial launch times, game load times, world loading, and **SD Card** performance. ### Community
- **Community & Steam Integration** — On-site comments plus existing reviews, artwork, and stats pulled directly from Steam. - **Rich text comments** — Tiptap-powered editor with threaded discussions
- **Open Source** — Fully transparent. Help us build the best resource for Deck gamers. - **Upvoting** — surface the most helpful contributions
- **Steam integration** — reviews, artwork, and stats pulled directly from Steam
### Platform
- **Unified search** — find games, hardware, and benchmarks in one place
- **Device profiles** — dedicated pages for each hardware device with OG image generation
- **Saved games** — bookmark and track the games you care about
- **Admin dashboard** — moderation tools for comments, reports, and content management
## Architecture
```
┌─────────────────────────────────────────────────┐
│ Next.js 16 │
│ (App Router + React 19) │
├─────────────────────────────────────────────────┤
│ app/ │ components/ │
│ ├── (auth)/ │ ├── comments/ │
│ ├── (manage)/manage/ │ ├── charts/ │
│ ├── api/[[...slugs]]/ │ ├── manage/ │
│ ├── game/[id]/ │ ├── profile/ │
│ ├── games/ │ └── wizard/ │
│ └── ... │ │
├─────────────────────────────────────────────────┤
│ Elysia API (catch-all route) │
│ lib/api/ — 24 route modules │
├─────────────────────────────────────────────────┤
│ Drizzle ORM → PostgreSQL │
│ lib/db/schema/ — 9 schema files │
├─────────────────────────────────────────────────┤
│ better-auth (Google + Discord OAuth, Passkeys) │
│ AWS S3 (file storage) · Resend (email) │
└─────────────────────────────────────────────────┘
```
The API layer uses [Elysia](https://elysiajs.com) mounted as a catch-all Next.js route handler at `app/api/[[...slugs]]/route.ts`. All route modules live in `lib/api/` and are composed into a single Elysia app.
## Tech Stack ## Tech Stack
- **[Next.js 16](https://nextjs.org)** — React framework (App Router) | Layer | Technology |
- **[React 19](https://react.dev)** — UI library |-------|-----------|
- **[TypeScript](https://www.typescriptlang.org)** — Type safety | Framework | [Next.js 16](https://nextjs.org) (App Router) |
- **[Tailwind CSS v4](https://tailwindcss.com)** — Utility-first styling | UI | [React 19](https://react.dev) · [Tailwind CSS v4](https://tailwindcss.com) |
- **[Elysia](https://elysiajs.com)** — Backend API framework | Language | [TypeScript](https://www.typescriptlang.org) |
- **[Drizzle ORM](https://orm.drizzle.team)** — Type-safe database queries | API | [Elysia](https://elysiajs.com) |
- **[PostgreSQL](https://www.postgresql.org)** — Primary database | Database | [PostgreSQL](https://www.postgresql.org) · [Drizzle ORM](https://orm.drizzle.team) |
- **[better-auth](https://better-auth.com)** — Authentication (Google & Discord OAuth) | Auth | [better-auth](https://better-auth.com) (Google, Discord, Passkeys, OTP) |
- **[Tiptap](https://tiptap.dev)** — Rich text editor | Editor | [Tiptap](https://tiptap.dev) (rich text) |
- **[Motion](https://motion.dev)** — Animations | Animations | [Motion](https://motion.dev) |
- **[AWS S3](https://aws.amazon.com/s3/)** — File storage | Charts | [ECharts](https://echarts.apache.org) |
- **[Bun](https://bun.sh)** — Package manager & runtime | Storage | [AWS S3](https://aws.amazon.com/s3/) |
| Email | [Resend](https://resend.com) |
| Runtime | [Bun](https://bun.sh) |
## Getting Started ## Getting Started
Clone the repository and install dependencies: ### Prerequisites
- [Bun](https://bun.sh) (v1.1+)
- PostgreSQL database
- Node.js 18+ (for Next.js compatibility)
### Installation
```bash ```bash
git clone https://github.com/AdrianBonpin/deckyvault.git
cd deckyvault
bun install bun install
``` ```
Copy the environment file and configure your values: ### Environment
Copy the example environment file and fill in your values:
```bash ```bash
cp .env.example .env.local cp .env.example .env.local
``` ```
Run the development server: Required variables:
| Variable | Description |
|----------|-------------|
| `DATABASE_URL` | PostgreSQL connection string |
| `BETTER_AUTH_SECRET` | Secret key for auth sessions |
| `BETTER_AUTH_URL` | Your app URL (e.g. `http://localhost:3000`) |
| `GOOGLE_CLIENT_ID` | Google OAuth client ID |
| `GOOGLE_CLIENT_SECRET` | Google OAuth client secret |
| `DISCORD_CLIENT_ID` | Discord OAuth client ID |
| `DISCORD_CLIENT_SECRET` | Discord OAuth client secret |
| `AWS_ACCESS_KEY_ID` | AWS S3 access key |
| `AWS_SECRET_ACCESS_KEY` | AWS S3 secret key |
| `AWS_S3_BUCKET` | S3 bucket name |
| `RESEND_API_KEY` | Resend API key for transactional email |
### Database
Push the schema to your database:
```bash
bun run db:push
```
Or generate and run migrations:
```bash
bun run db:generate
bun run db:migrate
```
Seed the database (optional):
```bash
bun run db:seed
```
### Development
```bash ```bash
bun run dev bun run dev
``` ```
Open [http://localhost:3000](http://localhost:3000) to see the result. Open [https://localhost:3000](https://localhost:3000) (self-signed HTTPS via `--experimental-https`).
## Scripts ## Scripts
| Command | Description | | Command | Description |
|---------|-------------| |---------|-------------|
| `bun run dev` | Start development server (HTTPS) | | `bun run dev` | Start dev server with HTTPS |
| `bun run build` | Create production build | | `bun run build` | Create production build |
| `bun run start` | Start production server | | `bun run start` | Start production server |
| `bun run lint` | Run ESLint | | `bun run lint` | Run ESLint |
| `bun run test` | Run tests with Vitest |
| `bun run test:watch` | Run tests in watch mode |
| `bun run db:push` | Push schema to database |
| `bun run db:generate` | Generate Drizzle migrations |
| `bun run db:migrate` | Run pending migrations |
| `bun run db:studio` | Open Drizzle Studio |
| `bun run db:seed` | Seed the database |
## Project Structure
```
deckyvault/
├── app/
│ ├── (auth)/ # Auth pages (sign-in, reset password)
│ ├── (manage)/manage/ # Admin dashboard
│ │ ├── benchmarks/ # Benchmark moderation
│ │ ├── comments/ # Comment moderation
│ │ ├── games/ # Game management & sync
│ │ ├── hardware/ # Hardware management
│ │ ├── reports/ # Report moderation
│ │ └── users/ # User management
│ ├── api/[[...slugs]]/ # Elysia API catch-all
│ ├── compare/ # Side-by-side game comparison
│ ├── game/[id]/ # Individual game page
│ ├── games/ # Games listing
│ ├── devices/ # Hardware device pages
│ ├── profile/ # User profiles
│ └── search/ # Unified search
├── components/
│ ├── auth/ # Auth-related components
│ ├── charts/ # ECharts wrappers
│ ├── comments/ # CommentSection, CommentItem
│ ├── manage/ # Admin sidebar
│ ├── profile/ # Settings tabs
│ └── wizard/ # Contribution wizard
├── lib/
│ ├── api/ # 24 Elysia route modules
│ ├── auth.ts # better-auth server config
│ ├── auth-client.ts # better-auth client
│ ├── db/
│ │ ├── schema/ # 9 Drizzle schema files
│ │ ├── index.ts # DB connection
│ │ └── seed.ts # Database seeder
│ ├── hooks/ # Custom React hooks
│ └── steam/ # Steam API integration
├── drizzle/ # Generated migrations
├── docs/superpowers/ # Plans & specs
└── public/ # Static assets
```
## Contributing ## Contributing
We welcome contributions of all kinds! Whether you want to: Contributions are welcome. Here's how to get involved:
- Suggest a new feature 1. **Report bugs** — [Open an issue](https://github.com/AdrianBonpin/deckyvault/issues) with steps to reproduce
- Report a bug 2. **Suggest features** — Describe the problem you're solving and your proposed approach
- Improve the design 3. **Submit code** — Fork the repo, create a branch, and [open a PR](https://github.com/AdrianBonpin/deckyvault/pulls)
- Contribute code
Feel free to open an [issue](https://github.com/AdrianBonpin/deckyvault/issues) or submit a [pull request](https://github.com/AdrianBonpin/deckyvault/pulls). ### Guidelines
If you're interested in helping develop or design the project, don't hesitate to reach out! - Follow existing code patterns and TypeScript conventions
- Run `bun run lint` and `bun run build` before submitting
## Roadmap - Keep PRs focused — one feature or fix per PR
- Include screenshots for UI changes
This project is actively being developed. Here are some of the major items on our radar:
- [ ] Core database and API for game entries
- [ ] Advanced search and filter system
- [ ] Community submission and moderation tools
- [ ] FPS graphing and historical data visualization
- [ ] Steam API integration for reviews, artwork, and stats
- [ ] Support for additional handheld devices *(future consideration)*
Stay tuned for updates!
## License ## License
This project is open-source. *(Add your specific license here, e.g., MIT, GPL-3.0)* MIT
## Acknowledgements ## Acknowledgements
- Built with love for the Steam Deck community. Built with love for the Steam Deck community.
- Check out the author's existing project for an idea of what to expect: **[https://grounds.ph](https://grounds.ph)**
Created by [Adrian Bonpin](https://grounds.ph).
--- ---