An open API service indexing awesome lists of open source software.

https://github.com/dcramer/peated


https://github.com/dcramer/peated

Last synced: 3 months ago
JSON representation

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:

## 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 [email protected] password -a
```

Load some mock data:

```
pnpm cli mocks load-all [email protected]
```

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
```