Skip to content

README.md

Latest commit

 

History

History
279 lines (258 loc) · 10.4 KB

README.md

File metadata and controls

279 lines (258 loc) · 10.4 KB

Stardew.app Logo
Next-generation, user friendly interface for tracking your journey to gaining perfection in Stardew Valley. ✨

Stardew.app Logo

The website uses Next.js for its frontend, self-hosted MySQL for its database, and a mixture of TypeScript and Python scripts to supplement data into the website. Internally, we use Linear for issue tracking and branch management.

Stardew.app Logo

Feature Notes
100% perfection tracking ✅
All 1.6 content ✅
Achievement tracking ✅
Fish tracker with location info ✅
Shipping tracker with crop info ✅
Villager tracker with gift info ✅
Recipe tracker ✅
Crafting recipe tracker ✅
Museum & artifacts tracker ✅
Bundles tracker ✅
Golden Walnut tracker ✅
Secret Note tracker ✅
Journal Scraps tracker ✅
Cross-platform support ✅
Discord login ✅

Stardew.app Logo

Thank you so much for wanting to contribute to stardew.app! We ask that you ensure your code is neat, adheres to the current programming style of the project, and runs without errors. Other than that, feel free to fix bugs, add features, and do whatever you desire to improve the website! stardew.app is built by the community, for the community, so we appreciate your contribution.

Below are some incredible people that the website wouldn't be without today!

clxmente
Clemente Solorio 		jacc
Jack LaFond 		Esummins
Eric Summins 		softy-dev
Softy 		hex2f
Leah Lundqvist 		IanMitchell
Ian Mitchell
FracturedShader
Robert Plante 		TheLDB
Landon 		brandonsaldan
Brandon Saldan 		Sarag1
Saragii 		ms7m
Mustafa 		tindolt
Tindolt
claude
Claude 		Aniket-Jena-02
Aniket Jena 		AnotherPillow
Null 		colemilne54
Cole Milne 		caoimhebyrne
Caoimhe 		dannykd
Danny Doan
dannyhand
Danny Hand 		OfficialCRUGG
Dennis Paulus 		JakobDev
JakobDev 		Terrance
Terrance 		TheLostSoul
Michael Harrington 		cnrad
Conrad Crawford
gustuxd
Gustavo Brito 		lucaspr98
Lucas Ramos 		moonggae
Euigeun Choi 		sol3uk
Ben Ashley

Local Development Setup

  1. Run bun install to install project dependencies.
  2. Copy .env.local.example to .env.local and update the MySQL credentials.
  3. Ensure MySQL is running locally.
  4. Run bun run prepLocalEnv to create the database and sync the schema.
  5. Run bun run dev to start the Next.js dev server at http://localhost:3000.

Testing against Cloudflare Workers locally

bun run dev runs a standard Next.js dev server — fast for iteration, but it does not emulate the Cloudflare runtime. To test with the actual Workers runtime locally (Hyperdrive bindings, etc.), use:

bun run preview

This builds the OpenNext Cloudflare bundle and runs it via Wrangler's local dev environment.

Deploying

bun run deploy

This builds the OpenNext bundle and deploys it to Cloudflare Workers via Wrangler.