feat: install initial required deps and update readme
This commit is contained in:
@@ -1,8 +1,56 @@
|
||||
This is a [Next.js](https://nextjs.org) project bootstrapped with [`create-next-app`](https://nextjs.org/docs/app/api-reference/cli/create-next-app).
|
||||
# DeckyVault
|
||||
|
||||
An open-source, community-driven database for Steam Deck (OLED & LCD) and Steam Machine compatibility, performance metrics, and settings.
|
||||
|
||||
[//]: # "Add shields here if available: e.g., license, contributors, last commit"
|
||||
|
||||
## Why DeckyVault?
|
||||
|
||||
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.
|
||||
|
||||
## Features
|
||||
|
||||
- **Community-First Contributions** — Built by the community, for the community. Anyone can contribute data and improvements.
|
||||
- **Streamlined Filters & Searching** — Quickly find the games you're looking for with powerful search and filtering.
|
||||
- **Rich Performance Metrics**
|
||||
- Community average FPS (**low**, **avg**, **high**).
|
||||
- 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.
|
||||
- **Historical FPS Graphs** — Track performance improvements over time across:
|
||||
- Game Versions
|
||||
- Proton / Native builds
|
||||
- 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.
|
||||
- **Comprehensive Compatibility Tracking**
|
||||
- Proton vs. Native status
|
||||
- Online Play & Anti-Cheat status
|
||||
- Straightforward "Playable" tags
|
||||
- **Loading & Storage Metrics** — Track initial launch times, game load times, world loading, and **SD Card** performance.
|
||||
- **Community & Steam Integration** — On-site comments plus existing reviews, artwork, and stats pulled directly from Steam.
|
||||
- **Open Source** — Fully transparent. Help us build the best resource for Deck gamers.
|
||||
|
||||
## Tech Stack
|
||||
|
||||
- **[Next.js](https://nextjs.org)** — React framework for production
|
||||
- **[React](https://react.dev)** — UI library
|
||||
- **[TypeScript](https://www.typescriptlang.org)** — Type safety
|
||||
- **[Tailwind CSS](https://tailwindcss.com)** — Utility-first styling *(verify in your local setup)*
|
||||
|
||||
## Getting Started
|
||||
|
||||
First, run the development server:
|
||||
First, clone the repository and install dependencies:
|
||||
|
||||
```bash
|
||||
npm install
|
||||
# or
|
||||
yarn install
|
||||
# or
|
||||
pnpm install
|
||||
```
|
||||
|
||||
Then, run the development server:
|
||||
|
||||
```bash
|
||||
npm run dev
|
||||
@@ -10,27 +58,47 @@ npm run dev
|
||||
yarn dev
|
||||
# or
|
||||
pnpm dev
|
||||
# or
|
||||
bun dev
|
||||
```
|
||||
|
||||
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
|
||||
|
||||
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
|
||||
You can start editing the pages by modifying files in the `app/` directory. The page auto-updates as you edit the file.
|
||||
|
||||
This project uses [`next/font`](https://nextjs.org/docs/app/building-your-application/optimizing/fonts) to automatically optimize and load [Geist](https://vercel.com/font), a new font family for Vercel.
|
||||
## Contributing
|
||||
|
||||
## Learn More
|
||||
We welcome contributions of all kinds! Whether you want to:
|
||||
|
||||
To learn more about Next.js, take a look at the following resources:
|
||||
- Suggest a new feature
|
||||
- Report a bug
|
||||
- Improve the design
|
||||
- Contribute code
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
|
||||
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
|
||||
Feel free to open an [issue](../../issues) or submit a [pull request](../../pulls).
|
||||
|
||||
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js) - your feedback and contributions are welcome!
|
||||
If you're interested in helping develop or design the project, don't hesitate to reach out!
|
||||
|
||||
## Deploy on Vercel
|
||||
## Roadmap
|
||||
|
||||
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
|
||||
This project is actively being developed. Here are some of the major items on our radar:
|
||||
|
||||
Check out our [Next.js deployment documentation](https://nextjs.org/docs/app/building-your-application/deploying) for more details.
|
||||
- [ ] 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
|
||||
|
||||
This project is open-source. *(Add your specific license here, e.g., MIT, GPL-3.0)*
|
||||
|
||||
## Acknowledgements
|
||||
|
||||
- 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)**
|
||||
|
||||
---
|
||||
|
||||
*DeckyVault is an independent project and is not affiliated with Valve Corporation.*
|
||||
|
||||
Reference in New Issue
Block a user