refactor: shift some text messages to work on blabsy (#199)

Author: sosweetham

platforms/blabsy/README.md

@@ -12,113 +12,112 @@ https://user-images.githubusercontent.com/55032197/201472767-9db0177a-79b5-4913-
 
 ## Features ✨
 
-- Authentication with Firebase Authentication
-- Strongly typed React components with TypeScript
-- Users can add tweets, like, retweet, and reply
-- Users can delete tweets, add a tweet to bookmarks, and pin their tweet
-- Users can add images and GIFs to tweet
-- Users can follow and unfollow other users
-- Users can see their and other followers and the following list
-- Users can see all users and the trending list
-- Realtime update likes, retweets, and user profile
-- Realtime trending data from Twitter API
-- User can edit their profile
-- Responsive design for mobile, tablet, and desktop
-- Users can customize the site color scheme and color background
-- All images uploads are stored on Firebase Cloud Storage
+-   Authentication with Firebase Authentication
+-   Strongly typed React components with TypeScript
+-   Users can add blabs, like, reblab, and reply
+-   Users can delete blabs, add a blab to bookmarks, and pin their blab
+-   Users can add images and GIFs to blab
+-   Users can follow and unfollow other users
+-   Users can see their and other followers and the following list
+-   Users can see all users and the trending list
+-   Realtime update likes, reblabs, and user profile
+-   User can edit their profile
+-   Responsive design for mobile, tablet, and desktop
+-   Users can customize the site color scheme and color background
+-   All images uploads are stored on Firebase Cloud Storage
 
 ## Tech 🛠
 
-- [Next.js](https://nextjs.org)
-- [TypeScript](https://www.typescriptlang.org)
-- [Tailwind CSS](https://tailwindcss.com)
-- [Firebase](https://firebase.google.com)
-- [SWR](https://swr.vercel.app)
-- [Headless UI](https://headlessui.com)
-- [React Hot Toast](https://react-hot-toast.com)
-- [Framer Motion](https://framer.com)
+-   [Next.js](https://nextjs.org)
+-   [TypeScript](https://www.typescriptlang.org)
+-   [Tailwind CSS](https://tailwindcss.com)
+-   [Firebase](https://firebase.google.com)
+-   [SWR](https://swr.vercel.app)
+-   [Headless UI](https://headlessui.com)
+-   [React Hot Toast](https://react-hot-toast.com)
+-   [Framer Motion](https://framer.com)
 
 ## Development 💻
 
 Here are the steps to run the project locally.
 
 1. Clone the repository
 
-   ```bash
-   git clone https://github.com/ccrsxx/twitter-clone.git
-   ```
+    ```bash
+    git clone https://github.com/MetaState-Prototype-Project/prototype.git
+    ```
 
 1. Install dependencies
 
-   ```bash
-   npm i
-   ```
+    ```bash
+    npm i
+    ```
 
 1. Create a Firebase project and select the web app
 
 1. Add your Firebase config to `.env.development`. Note that `NEXT_PUBLIC_MEASUREMENT_ID` is optional
 
 1. Make sure you have enabled the following Firebase services:
 
-   - Authentication. Enable the Google sign-in method.
-   - Cloud Firestore. Create a database and set its location to your nearest region.
-   - Cloud Storage. Create a storage bucket.
+    - Authentication. Enable the Google sign-in method.
+    - Cloud Firestore. Create a database and set its location to your nearest region.
+    - Cloud Storage. Create a storage bucket.
 
 1. Install Firebase CLI globally
 
-   ```bash
-   npm i -g firebase-tools
-   ```
+    ```bash
+    npm i -g firebase-tools
+    ```
 
 1. Log in to Firebase
 
-   ```bash
-   firebase login
-   ```
+    ```bash
+    firebase login
+    ```
 
 1. Get your project ID
 
-   ```bash
-   firebase projects:list
-   ```
+    ```bash
+    firebase projects:list
+    ```
 
 1. Select your project ID
 
-   ```bash
-   firebase use your-project-id
-   ```
+    ```bash
+    firebase use your-project-id
+    ```
 
 1. At this point, you have two choices. Either run this project using the Firebase on the cloud or locally using emulator.
 
-   1. Using the Firebase Cloud Backend:
+    1. Using the Firebase Cloud Backend:
 
-      1. Deploy Firestore rules, Firestore indexes, and Cloud Storage rules
+        1. Deploy Firestore rules, Firestore indexes, and Cloud Storage rules
 
-         ```bash
-         firebase deploy --except functions
-         ```
+            ```bash
+            firebase deploy --except functions
+            ```
 
-      1. Run the project
+        1. Run the project
 
-         ```bash
-         npm run dev
-         ```
+            ```bash
+            npm run dev
+            ```
 
-   1. Using Firebase Local Emulator:
+    1. Using Firebase Local Emulator:
 
-      1. Install [Java JDK version 11 or higher](https://jdk.java.net/) before proceeding. This is required to run the emulators.
+        1. Install [Java JDK version 11 or higher](https://jdk.java.net/) before proceeding. This is required to run the emulators.
 
-      1. Set the environment variable `NEXT_PUBLIC_USE_EMULATOR` to `true` in `.env.development`. This will make the app use the emulators instead of the cloud backend.
+        1. Set the environment variable `NEXT_PUBLIC_USE_EMULATOR` to `true` in `.env.development`. This will make the app use the emulators instead of the cloud backend.
 
-      1. At this point, you can run the following command to have a fully functional Twitter clone running locally:
+        1. At this point, you can run the following command to have a fully functional Twitter clone running locally:
 
-         ```bash
-         npm run dev:emulators
-         ```
+            ```bash
+            npm run dev:emulators
+            ```
 
 > **_Note_**: When you deploy Firestore indexes rules, it might take a few minutes to complete. So before the indexes are enabled, you will get an error when you fetch the data from Firestore.<br><br>You can check the status of your Firestore indexes with the link below, replace `your-project-id` with your project ID: https://console.firebase.google.com/u/0/project/your-project-id/firestore/indexes
 
 Optional:
 
-- If you want to get trending data from Twitter API, you need to create a Twitter developer account and get your API keys. Then add your API keys to `.env.development`. I hope Elon Musk doesn't make this API paid 😅.
-- If you want to make the user stats synced with the deleted tweets, you need to enable the Cloud Functions for Firebase. Then deploy the Cloud Functions.
+-   If you want to get trending data from Twitter API, you need to create a Twitter developer account and get your API keys. Then add your API keys to `.env.development`. I hope Elon Musk doesn't make this API paid 😅.
+-   If you want to make the user stats synced with the deleted blabs, you need to enable the Cloud Functions for Firebase. Then deploy the Cloud Functions.

platforms/blabsy/functions/src/normalize-stats.ts

@@ -1,49 +1,49 @@
-import { functions, firestore, regionalFunctions } from './lib/utils';
-import { tweetConverter, bookmarkConverter } from './types';
-import type { Tweet } from './types';
+import { firestore, functions, regionalFunctions } from "./lib/utils";
+import { bookmarkConverter, tweetConverter } from "./types";
+import type { Tweet } from "./types";
 
 export const normalizeStats = regionalFunctions.firestore
-  .document('tweets/{tweetId}')
-  .onDelete(async (snapshot): Promise<void> => {
-    const tweetId = snapshot.id;
-    const tweetData = snapshot.data() as Tweet;
+    .document("tweets/{tweetId}")
+    .onDelete(async (snapshot): Promise<void> => {
+        const tweetId = snapshot.id;
+        const tweetData = snapshot.data() as Tweet;
 
-    functions.logger.info(`Normalizing stats from tweet ${tweetId}`);
+        functions.logger.info(`Normalizing stats from tweet ${tweetId}`);
 
-    const { userRetweets, userLikes } = tweetData;
+        const { userRetweets, userLikes } = tweetData;
 
-    const usersStatsToDelete = new Set([...userRetweets, ...userLikes]);
+        const usersStatsToDelete = new Set([...userRetweets, ...userLikes]);
 
-    const batch = firestore().batch();
+        const batch = firestore().batch();
 
-    usersStatsToDelete.forEach((userId) => {
-      functions.logger.info(`Deleting stats from ${userId}`);
+        usersStatsToDelete.forEach((userId) => {
+            functions.logger.info(`Deleting stats from ${userId}`);
 
-      const userStatsRef = firestore()
-        .doc(`users/${userId}/stats/stats`)
-        .withConverter(tweetConverter);
+            const userStatsRef = firestore()
+                .doc(`users/${userId}/stats/stats`)
+                .withConverter(tweetConverter);
 
-      batch.update(userStatsRef, {
-        tweets: firestore.FieldValue.arrayRemove(tweetId),
-        likes: firestore.FieldValue.arrayRemove(tweetId)
-      });
-    });
+            batch.update(userStatsRef, {
+                tweets: firestore.FieldValue.arrayRemove(tweetId),
+                likes: firestore.FieldValue.arrayRemove(tweetId),
+            });
+        });
 
-    const bookmarksQuery = firestore()
-      .collectionGroup('bookmarks')
-      .where('id', '==', tweetId)
-      .withConverter(bookmarkConverter);
+        const bookmarksQuery = firestore()
+            .collectionGroup("bookmarks")
+            .where("id", "==", tweetId)
+            .withConverter(bookmarkConverter);
 
-    const docsSnap = await bookmarksQuery.get();
+        const docsSnap = await bookmarksQuery.get();
 
-    functions.logger.info(`Deleting ${docsSnap.size} bookmarks`);
+        functions.logger.info(`Deleting ${docsSnap.size} bookmarks`);
 
-    docsSnap.docs.forEach(({ id, ref }) => {
-      functions.logger.info(`Deleting bookmark ${id}`);
-      batch.delete(ref);
-    });
+        docsSnap.docs.forEach(({ id, ref }) => {
+            functions.logger.info(`Deleting bookmark ${id}`);
+            batch.delete(ref);
+        });
 
-    await batch.commit();
+        await batch.commit();
 
-    functions.logger.info(`Normalizing stats for tweet ${tweetId} is done`);
-  });
+        functions.logger.info(`Normalizing stats for blab ${tweetId} is done`);
+    });

platforms/blabsy/functions/src/notify-email.ts

@@ -1,45 +1,47 @@
-import { createTransport } from 'nodemailer';
-import { firestore, functions, regionalFunctions } from './lib/utils';
-import { EMAIL_API, EMAIL_API_PASSWORD, TARGET_EMAIL } from './lib/env';
-import type { Tweet, User } from './types';
+import { createTransport } from "nodemailer";
+import { EMAIL_API, EMAIL_API_PASSWORD, TARGET_EMAIL } from "./lib/env";
+import { firestore, functions, regionalFunctions } from "./lib/utils";
+import type { Tweet, User } from "./types";
 
 export const notifyEmail = regionalFunctions.firestore
-  .document('tweets/{tweetId}')
-  .onCreate(async (snapshot): Promise<void> => {
-    functions.logger.info('Sending notification email.');
-
-    const { text, createdBy, images, parent } = snapshot.data() as Tweet;
-
-    const imagesLength = images?.length ?? 0;
-
-    const { name, username } = (
-      await firestore().doc(`users/${createdBy}`).get()
-    ).data() as User;
-
-    const client = createTransport({
-      service: 'Gmail',
-      auth: {
-        user: EMAIL_API.value(),
-        pass: EMAIL_API_PASSWORD.value()
-      }
-    });
-
-    const tweetLink = `https://twitter-clone-ccrsxx.vercel.app/tweet/${snapshot.id}`;
-
-    const emailHeader = `New Tweet${
-      parent ? ' reply' : ''
-    } from ${name} (@${username})`;
-
-    const emailText = `${text ?? 'No text provided'}${
-      images ? ` (${imagesLength} image${imagesLength > 1 ? 's' : ''})` : ''
-    }\n\nLink to Tweet: ${tweetLink}\n\n- Firebase Function.`;
-
-    await client.sendMail({
-      from: EMAIL_API.value(),
-      to: TARGET_EMAIL.value(),
-      subject: emailHeader,
-      text: emailText
+    .document("tweets/{tweetId}")
+    .onCreate(async (snapshot): Promise<void> => {
+        functions.logger.info("Sending notification email.");
+
+        const { text, createdBy, images, parent } = snapshot.data() as Tweet;
+
+        const imagesLength = images?.length ?? 0;
+
+        const { name, username } = (
+            await firestore().doc(`users/${createdBy}`).get()
+        ).data() as User;
+
+        const client = createTransport({
+            service: "Gmail",
+            auth: {
+                user: EMAIL_API.value(),
+                pass: EMAIL_API_PASSWORD.value(),
+            },
+        });
+
+        const tweetLink = `https://twitter-clone-ccrsxx.vercel.app/tweet/${snapshot.id}`;
+
+        const emailHeader = `New Blab${
+            parent ? " reply" : ""
+        } from ${name} (@${username})`;
+
+        const emailText = `${text ?? "No text provided"}${
+            images
+                ? ` (${imagesLength} image${imagesLength > 1 ? "s" : ""})`
+                : ""
+        }\n\nLink to Blab: ${tweetLink}\n\n- Firebase Function.`;
+
+        await client.sendMail({
+            from: EMAIL_API.value(),
+            to: TARGET_EMAIL.value(),
+            subject: emailHeader,
+            text: emailText,
+        });
+
+        functions.logger.info("Notification email sent.");
     });
-
-    functions.logger.info('Notification email sent.');
-  });