feat: sync ChatKitty application with Firebase project

.github/workflows/release.yml

@@ -22,16 +22,11 @@ jobs:
         with:
           node-version: 20
 
-      - name: Install build dependencies
+      - name: Install dependencies
         run: npm ci
 
-      - name: Install functions dependencies
-        working-directory: functions
-        run: npm ci
-
-      - name: Build functions
-        working-directory: functions
-        run: npm run build:package
+      - name: Generate README
+        run: npm run generate:readme
 
       - name: Release
         env:

.releaserc.yml

@@ -8,9 +8,9 @@ plugins:
   - - "@semantic-release/github"
   - - "@semantic-release/git"
     - assets:
-        - "functions/lib/**"
         - "extension.yaml"
         - "CHANGELOG.md"
+        - "README.md"
       message: "chore(release): prepare ${nextRelease.version} [skip ci]"
 
 branches:

CHANGELOG.md

@@ -1,11 +1,11 @@
-## [1.0.1](https://github.com/ChatKitty/chatkitty-firebase-extension/compare/1.0.0...1.0.1) (2024-08-15)
+## Version 1.0.1
 
 
 ### Bug Fixes
 
 * build functions on release ([9797dfa](https://github.com/ChatKitty/chatkitty-firebase-extension/commit/9797dfa23d84189db5fb68602cfa7332fe5adb5c))
 
-## Version 1.0.0 (2024-08-15)
+## Version 1.0.0
 
 
 ### Bug Fixes

README.md

@@ -0,0 +1,48 @@
+# ChatKitty
+
+**Author**: ChatKitty, Inc. (**[https://chatkitty.com](https://chatkitty.com)**)
+
+**Description**: ChatKitty is a complete chat platform you can use to build real-time chat features in your app.
+
+
+
+**Details**: # ChatKitty Firebase Extension - Pre-installation Guide
+
+Welcome to the ChatKitty Firebase Extension! This guide will walk you through the prerequisites and preparation steps you need to complete before installing the ChatKitty Firebase Extension. Ensuring these requirements are met will help you avoid issues during the installation and configuration process.
+
+## Prerequisites
+
+Before you install the ChatKitty Firebase Extension, please ensure that you meet the following prerequisites:
+
+### 1. Firebase Project
+
+You must have a Firebase project set up. If you don't already have a Firebase project, you can create one by following these steps:
+
+1. Go to the [Firebase Console](https://console.firebase.google.com/).
+2. Click on **"Add Project."**
+3. Follow the on-screen instructions to set up your Firebase project.
+
+### 2. Firebase Authentication
+
+ChatKitty requires Firebase Authentication for user management. Make sure Firebase Authentication is enabled in your Firebase project:
+
+1. In the Firebase Console, navigate to **Authentication**.
+2. Click on **"Get started"** if you haven’t already enabled it.
+3. Set up at least one sign-in method (e.g., Email/Password, Google, etc.).
+
+
+
+
+**Configuration Parameters:**
+
+* ChatKitty Client ID: Your ChatKitty Client ID. You can find this in your ChatKitty console.
+
+* ChatKitty Client Secret: Your ChatKitty Client Secret. You can find this in your ChatKitty console.
+
+
+
+**Cloud Functions:**
+
+* **handleCreateUser:** Listens for user accounts to be created in your Firebase project and creates a ChatKitty user for each new user.
+
+* **handleDeleteUser:** Listens for user accounts to be deleted in your Firebase project and deletes the corresponding ChatKitty user.

demo/.firebaserc

@@ -0,0 +1 @@
+{}

demo/.gitignore

@@ -0,0 +1,69 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+firebase-debug.*.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# dataconnect generated files
+.dataconnect

demo/client/.eslintrc.cjs

@@ -0,0 +1,15 @@
+/* eslint-env node */
+require('@rushstack/eslint-patch/modern-module-resolution')
+
+module.exports = {
+  root: true,
+  'extends': [
+    'plugin:vue/vue3-essential',
+    'eslint:recommended',
+    '@vue/eslint-config-typescript',
+    '@vue/eslint-config-prettier/skip-formatting'
+  ],
+  parserOptions: {
+    ecmaVersion: 'latest'
+  }
+}

demo/client/.gitignore

@@ -0,0 +1,30 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tsbuildinfo

demo/client/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "tabWidth": 2,
+  "singleQuote": true,
+  "printWidth": 100,
+  "trailingComma": "none"
+}

demo/client/README.md

@@ -0,0 +1,39 @@
+# client
+
+This template should help get you started developing with Vue 3 in Vite.
+
+## Recommended IDE Setup
+
+[VSCode](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur).
+
+## Type Support for `.vue` Imports in TS
+
+TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) to make the TypeScript language service aware of `.vue` types.
+
+## Customize configuration
+
+See [Vite Configuration Reference](https://vitejs.dev/config/).
+
+## Project Setup
+
+```sh
+npm install
+```
+
+### Compile and Hot-Reload for Development
+
+```sh
+npm run dev
+```
+
+### Type-Check, Compile and Minify for Production
+
+```sh
+npm run build
+```
+
+### Lint with [ESLint](https://eslint.org/)
+
+```sh
+npm run lint
+```

demo/client/env.d.ts

@@ -0,0 +1 @@
+/// <reference types="vite/client" />

demo/client/index.html

@@ -0,0 +1,13 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <link rel="icon" href="/favicon.ico">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Vite App</title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>