1
0
Fork 0
gmscreen/CONTRIBUTING.md
2024-11-13 18:52:20 -07:00

29 lines
618 B
Markdown

# GMScreen Contributing
## Project Setup
### Dependencies
- [mise-en-place](https://mise.jdx.dev/) globally installed
- `mise use` will install tools such as `bun` and potentially more
### Stack
- Bun (Serverside JS Runner, Server)
- LibSQL (SQLite replacement, database)
- Drizzle
- DrizzleKit
### Updating the Database (DB)
Data is stored in `./db.sqlite`, **but do not modify that file manually.**
### To update the data within the tables
Update the files in `./src/db/data`
Then run `bun drizzle-kit push`
### To update the schema
Update the file in `./src/schema.ts`
Then run `bun src/db/index.ts`