feat: Add tRPC application server and Firestore database (#2063)

Author: koistya

.env

@@ -11,11 +11,13 @@ APP_NAME=Acme Co.
 APP_HOSTNAME=localhost
 APP_ORIGIN=http://localhost:5173
 API_ORIGIN=https://api-mcfytwakla-uc.a.run.app
+APP_STORAGE_BUCKET=example.com
 
 # Google Cloud
 # https://console.cloud.google.com/
 GOOGLE_CLOUD_PROJECT=kriasoft
 GOOGLE_CLOUD_REGION=us-central1
+GOOGLE_CLOUD_DATABASE="(default)"
 GOOGLE_CLOUD_CREDENTIALS={"type":"service_account","project_id":"example","private_key_id":"xxx","private_key":"-----BEGIN PRIVATE KEY-----\nxxxxx\n-----END PRIVATE KEY-----\n","client_email":"application@exmaple.iam.gserviceaccount.com","client_id":"xxxxx","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/application%40example.iam.gserviceaccount.com"}
 
 # Firebase
@@ -24,6 +26,11 @@ FIREBASE_APP_ID=1:736557952746:web:b5ee23841e24c0b883b193
 FIREBASE_API_KEY=AIzaSyAZDmdeRWvlYgZpwm6LBCkYJM6ySIMF2Hw
 FIREBASE_AUTH_DOMAIN=kriasoft.web.app
 
+# OpenAI
+# https://platform.openai.com/
+OPENAI_ORGANIZATION=xxxxx
+OPENAI_API_KEY=xxxxx
+
 # Cloudflare
 # https://dash.cloudflare.com/
 # https://developers.cloudflare.com/api/tokens/create

.vscode/settings.json

@@ -61,23 +61,28 @@
     "firestore",
     "globby",
     "hono",
+    "identitytoolkit",
     "jamstack",
     "kriasoft",
     "localforage",
     "miniflare",
     "nodenext",
     "notistack",
     "oidc",
+    "openai",
     "pathinfo",
+    "pino",
     "pnpify",
     "reactstarter",
     "refetch",
     "refetchable",
+    "relyingparty",
     "sendgrid",
     "signup",
     "sourcemap",
     "spdx",
     "swapi",
+    "trpc",
     "tslib",
     "typechecking",
     "vite",

README.md

@@ -31,9 +31,11 @@ Be sure to join our [Discord channel](https://discord.com/invite/2nKEnKq) for as
 `├──`[`.github`](.github) — GitHub configuration including CI/CD workflows<br>
 `├──`[`.vscode`](.vscode) — VSCode settings including code snippets, recommended extensions etc.<br>
 `├──`[`app`](./app) — Web application front-end built with [React](https://react.dev/) and [Joy UI](https://mui.com/joy-ui/getting-started/)<br>
+`├──`[`db`](./db) — Firestore database schema, seed data, and admin tools<br>
 `├──`[`edge`](./edge) — Cloudflare Workers (CDN) edge endpoint<br>
 `├──`[`env`](./env) — Application settings, API keys, etc.<br>
 `├──`[`scripts`](./scripts) — Automation scripts such as `yarn deploy`<br>
+`├──`[`server`](./server) — Node.js application server built with [tRPC](https://trpc.io/)<br>
 `├──`[`tsconfig.base.json`](./tsconfig.base.json) — The common/shared TypeScript configuration<br>
 `└──`[`tsconfig.json`](./tsconfig.json) — The root TypeScript configuration<br>
 

app/package.json

@@ -36,7 +36,7 @@
   "devDependencies": {
     "@babel/core": "^7.23.7",
     "@emotion/babel-plugin": "^11.11.0",
-    "@types/node": "^20.10.6",
+    "@types/node": "^20.10.7",
     "@types/react": "^18.2.47",
     "@types/react-dom": "^18.2.18",
     "@vitejs/plugin-react": "^4.2.1",

db/README.md

@@ -0,0 +1,20 @@
+# Firestore Database
+
+Database schema, security rules, indexes, and seed data for the [Firestore](https://cloud.google.com/firestore) database.
+
+## Directory Structure
+
+- [`/models`](./models/) — Database schema definitions using [Zod](https://zod.dev/).
+- [`/seeds`](./seeds/) — Sample / reference data for the database.
+- [`/scripts`](./scripts/) — Scripts for managing the database.
+- [`/firestore.indexes.json`](./firestore.indexes.json) — Firestore indexes.
+- [`/firestore.rules`](./firestore.rules) — Firestore security rules.
+
+## Scripts
+
+- `yarn workspace db seed` - Seed the database with data from [`/seeds`](./seeds/).
+
+## References
+
+- https://zod.dev/
+- https://cloud.google.com/firestore

db/firestore.indexes.json

@@ -0,0 +1,13 @@
+{
+  "indexes": [
+    {
+      "collectionGroup": "workspace",
+      "queryScope": "COLLECTION",
+      "fields": [
+        { "fieldPath": "ownerId", "order": "ASCENDING" },
+        { "fieldPath": "archived", "order": "DESCENDING" }
+      ]
+    }
+  ],
+  "fieldOverrides": []
+}

db/firestore.rules

@@ -0,0 +1,19 @@
+// Firestore security rules.
+// https://cloud.google.com/firestore/docs/security/get-started
+
+rules_version = '2';
+
+service cloud.firestore {
+  match /databases/{database}/documents {
+    match /workspace/{id} {
+      allow read: if request.auth != null && (
+        resource.data.ownerId = request.auth.uid ||
+        request.auth.token.admin == true
+      );
+    }
+
+    match /{document=**} {
+      allow read, write: if false;
+    }
+  }
+}

db/index.ts

@@ -0,0 +1,6 @@
+/* SPDX-FileCopyrightText: 2014-present Kriasoft */
+/* SPDX-License-Identifier: MIT */
+
+export * from "./models";
+export { testUsers } from "./seeds/01-users";
+export { testWorkspaces } from "./seeds/02-workspaces";

db/models/index.ts

@@ -0,0 +1,4 @@
+/* SPDX-FileCopyrightText: 2014-present Kriasoft */
+/* SPDX-License-Identifier: MIT */
+
+export * from "./workspace";

db/models/workspace.ts

@@ -0,0 +1,16 @@
+/* SPDX-FileCopyrightText: 2014-present Kriasoft */
+/* SPDX-License-Identifier: MIT */
+
+import { Timestamp } from "@google-cloud/firestore";
+import { z } from "zod";
+
+export const WorkspaceSchema = z.object({
+  name: z.string().max(100),
+  ownerId: z.string().max(50),
+  created: z.instanceof(Timestamp),
+  updated: z.instanceof(Timestamp),
+  archived: z.instanceof(Timestamp).nullable(),
+});
+
+export type Workspace = z.output<typeof WorkspaceSchema>;
+export type WorkspaceInput = z.input<typeof WorkspaceSchema>;