https://github.com/dcramer/peated
https://github.com/dcramer/peated
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dcramer/peated
- Owner: dcramer
- License: apache-2.0
- Created: 2023-04-02T18:54:52.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-08-05T20:56:56.000Z (5 months ago)
- Last Synced: 2025-08-06T17:03:34.263Z (5 months ago)
- Language: HTML
- Homepage: https://peated.com
- Size: 16.3 MB
- Stars: 83
- Watchers: 3
- Forks: 17
- Open Issues: 73
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Peated
The application that powers peated.com.
For more details, take a look at
A Discord is available if you want to contribute:
## Features
### Rating Systems
Peated is transitioning to a new simplified rating system:
- **Simple Rating**: Whisky-themed Pass/Sip/Savor system for quick, meaningful ratings
- **Traditional 5-Star Rating (Deprecated)**: Legacy ratings from 0-5 will remain viewable but are being phased out
See [Simple Rating System Documentation](./docs/features/simple-rating-system.md) for more details.
## Dev
Setup the required frameworks:
1. [pnpm](https://pnpm.io/installation)
2. [Docker](https://docs.docker.com/get-docker/) (with Docker Compose)
Bootstrap the environment:
```
docker compose up -d
pnpm install
```
Note: If you need to tweak default settings, `cp .env.example .env` and go to town.
Setup the database:
```
make create-db
pnpm db migrate
```
Create a local user to avoid setting up Google credentials:
```
pnpm cli users create you@example.com password -a -v
```
Load some mock data:
```
pnpm cli mocks load-all you@example.com
```
Run the dev server, which spins up both the `web` and the `api` services:
```
npm run dev
```
## Runbooks
### Configure GCP CLI
```shell
# bind default project
gcloud config set project cask-382601
# configure kubectl
gcloud container clusters get-credentials default --region=us-central1
```
### Shell on Pod
```shell
kubectl exec -it deploy/peated-api -- bash
```
### Run Arbitrary Command
```shell
gcloud alpha run jobs execute cli --args bottles,generate-descriptions,3298 --wait
```