WYSIWYG Email Editor

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,26 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.1.1/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": [
+    "@courselit/web",
+    "@courselit/state-management",
+    "@courselit/utils",
+    "@courselit/queue",
+    "@courselit/icons",
+    "@courselit/components-library",
+    "tsconfig",
+    "tailwind-config",
+    "@courselit/page-blocks",
+    "@courselit/text-editor",
+    "@courselit/common-logic",
+    "@courselit/page-primitives",
+    "@courselit/common-models",
+    "@courselit/docs"
+  ]
+}

.github/workflows/publish-docker-images.yaml

@@ -6,60 +6,7 @@ on:
       - '*'
 
 jobs:
-#   publish-packages:
-#     runs-on: ubuntu-latest
-#     steps:
-#       - name: checkout
-#         uses: actions/checkout@v1
-
-#       - name: Configure CI Git User
-#         run: |
-#           git config --global user.name 'Rajat Saxena'
-#           git config --global user.email 'hi@sub.rajatsaxena.dev'
-#           git remote set-url origin https://$GITHUB_ACTOR:$GITHUB_PAT@github.com/codelitdev/courselit
-#         env:
-#           GITHUB_PAT: ${{ secrets.PAT }}
-
-#       - name: Checkout and pull branch
-#         run: |
-#           LATEST_TAG=$(git describe --tags `git rev-list --tags --max-count=1`)
-#           git checkout $LATEST_TAG
-
-#       - name: Setup pnpm
-#         uses: pnpm/action-setup@v2
-#         with:
-#           version: 8
-
-#       - name: Install Packages
-#         run: pnpm install
-
-#       - name: Authenticate with Registry
-#         run: |
-#           echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
-#           pnpm whoami
-#         env:
-#           NPM_TOKEN: ${{ secrets.NPM }}
-
-#       - name: Build packages
-#         run: |
-#           pnpm --filter @courselit/icons build
-#           pnpm --filter @courselit/common-models build
-#           pnpm --filter @courselit/utils build
-#           pnpm --filter @courselit/text-editor build
-#           pnpm --filter @courselit/state-management build
-#           pnpm --filter @courselit/components-library build
-#           pnpm --filter @courselit/common-widgets build
-
-#       - name: Publish package
-#         run: |
-#           pnpm publish
-#         env:
-#           GH_TOKEN: ${{ secrets.PAT }}
-#           GITHUB_TOKEN: ${{ secrets.PAT }}
-#           NPM_TOKEN: ${{ secrets.NPM }}
-
   publish-docker-images:
-    # needs: publish-packages
     runs-on: ubuntu-latest
     steps:
       - name: checkout

.github/workflows/publish-packages.yaml

@@ -0,0 +1,62 @@
+name: Publish NPM packages
+
+on:
+  push:
+    branches:
+      - main
+    tags-ignore:
+      - '**'
+
+concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+env:
+  CI: true
+
+jobs:
+  publish-packages:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v1
+
+      - name: Configure CI Git User
+        run: |
+          git config --global user.name 'Rajat Saxena'
+          git config --global user.email 'hi@sub.rajatsaxena.dev'
+          git remote set-url origin https://$GITHUB_ACTOR:$GITHUB_PAT@github.com/codelitdev/courselit
+        env:
+          GITHUB_PAT: ${{ secrets.PAT }}
+
+      - name: Checkout and pull branch
+        run: |
+          git checkout ${{ github.ref_name }}
+          git pull origin ${{ github.ref_name }}
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v2
+        with:
+          version: 8
+
+      - name: Install Packages
+        run: pnpm install
+
+      - name: Authenticate with Registry
+        run: |
+          echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" > .npmrc
+          pnpm whoami
+        env:
+          NPM_TOKEN: ${{ secrets.NPM }}
+
+      - name: Create and publish versions
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          commit: "chore: update versions"
+          title: "chore: update versions"
+          publish: pnpm ci:publish 
+        env:
+          GITHUB_TOKEN: ${{ secrets.PAT }}
+          NPM_TOKEN: ${{ secrets.NPM }}
+
+      - name: Echo changeset output
+        run: echo "${{ steps.changesets.outputs.hasChangesets }}"

.github/workflows/test.yaml

@@ -17,6 +17,7 @@ jobs:
       run: |
           pnpm --filter @courselit/icons build
           pnpm --filter @courselit/page-models build
+          pnpm --filter @courselit/email-editor build
           pnpm --filter @courselit/common-models build
           pnpm --filter @courselit/utils build
           pnpm --filter @courselit/text-editor build

.gitignore

@@ -37,4 +37,6 @@ report*.json
 .DS_Store
 
 # Dev tools files
-.eslintcache
+.eslintcache
+
+.npmrc

.husky/pre-commit

@@ -1,5 +1,4 @@
 #!/usr/bin/env sh
 . "$(dirname "$0")/_/husky.sh"
 
-pnpm exec lint-staged
-pnpm test
+pnpm exec lint-staged

apps/docs/src/config.ts

@@ -86,8 +86,8 @@ export const SIDEBAR: Sidebar = {
                 link: "en/email-marketing/mail-access-request",
             },
             {
-                text: "Broadcast mails",
-                link: "en/email-marketing/broadcast-mails",
+                text: "Broadcasts",
+                link: "en/email-marketing/broadcasts",
             },
             {
                 text: "Sequences (Campaigns)",

apps/docs/src/pages/en/email-marketing/broadcasts.md

@@ -0,0 +1,75 @@
+---
+title: Broadcasts
+description: Send one-off emails to your audience
+layout: ../../../layouts/MainLayout.astro
+---
+
+Broadcast emails are typically sent to your entire list or specific segments simultaneously, making them ideal for announcements, promotions, or updates.
+
+> This feature is currently in beta, which means you may encounter bugs. Please report them in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> group if you run into any issues.
+
+> **Before you start**: If your school is hosted on [courselit.app](https://courselit.app), you need to get approved to send marketing emails. [Request access here](/en/email-marketing/mail-access-request).
+
+## Broadcasts Hub
+
+From the `Dashboard`, go to `Mails` to land on the `Broadcasts` hub. Here, you will see all the broadcasts you have ever worked on.
+
+![Broadcasts Hub](/assets/emails/broadcasts-hub.png)
+
+## Compose Your Email
+
+1. Click the `New broadcast` button on the right, in the `Broadcasts` hub.
+
+2. Let's get acquainted with the interface. In the following image, we have marked all the sections. To see the description of a section, note its number in the screenshot and find its description below.
+
+    -   1. **User Filters**: To select the users.
+    -   2. **Total Selected Users**: The total number of selected users as per the applied filters.
+    -   3. **Subject**: The email subject goes here.
+    -   4. **Email Preview**: Live email preview.
+            > During the preview, variables will be displayed as placeholders. The actual values will be replaced when sending the actual email.
+    -   5. **Mail Edit Button**: Opens the mail for editing.
+    -   6. **Send Button**: Sends the email immediately.
+    -   7. **Schedule Button**: Lets you schedule an email for later.
+
+    ![Broadcast Compose](/assets/emails/compose-broadcast.png)
+
+3. Upon clicking the **Mail Edit** button, a full-page email editor will open where you can edit the email.
+
+    > When done, simply press the exit button. All changes are auto-saved.
+
+    ![Email editor](/assets/emails/email-editor.png)
+
+    We have annotated the screenshot of the CourseLit email editor:
+
+    -   1. **Variables**: You can use these variables in your emails. These variables will be replaced with the actual data when sending the email.
+    -   2. **Email Preview**: The live preview of the email.
+    -   3. **Settings Pane**: The settings pane for the email and the selected block.
+    -   4. **Exit Button**: The email editor exit button.
+
+4. If you are not yet ready to send the email or schedule it, you can simply go back to the Broadcasts hub by clicking on the `Broadcasts` breadcrumb (located at the top of the page).
+
+## Send Immediately
+
+Once your email is ready, you can either send it right away or schedule it for later. Click the `Send` button to send the email immediately.
+
+## Schedule for Later
+
+Click the `Schedule` button to see an additional input box to enter the date and time to send the email, as shown below. The time you select here is based on your own time zone.
+
+> In the background, all dates and times are converted to UTC.
+
+![Schedule Broadcast Mail](/assets/emails/schedule.jpeg)
+
+### Canceling a Scheduled Email
+
+Once an email is scheduled, you will see the time it will be sent at the bottom, as shown below. Simply click the `Cancel sending` button to cancel the scheduled send.
+
+![Cancel Scheduled Mail](/assets/emails/scheduled-mail.jpeg)
+
+## Next Step
+
+Let's see how to send automated email campaigns (also known as sequences) when something happens in your school. [Click here](/en/email-marketing/sequences).
+
+## Stuck Somewhere?
+
+We are always here for you. Come chat with us in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> channel or send a tweet to <a href="https://twitter.com/courselit" target="_blank">@CourseLit</a>.

apps/docs/src/pages/en/email-marketing/introduction.md

@@ -4,26 +4,26 @@ description: Send broadcasts and email sequences using CourseLit
 layout: ../../../layouts/MainLayout.astro
 ---
 
-Sending timely emails to your audience keeps them engaged, which is why CourseLit includes a seamless integration solution for email marketing and automation.
+Sending timely emails to your audience keeps them engaged, which is why CourseLit includes a seamless solution for email marketing and automation.
 
-> The feature is currently in beta, which means you may encounter bugs. Please report them in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> group if you run into any.
+> This feature is currently in beta, which means you may encounter bugs. Please report them in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> group if you run into any issues.
 
 ## Mailing Capabilities
 
-CourseLit offers two types of mails.
+CourseLit offers two types of emails:
 
-#### 1. [Broadcasts](/en/email-marketing/broadcast-mails)
+#### 1. [Broadcasts](/en/email-marketing/broadcasts)
 
 Send one-off emails to selected recipients for quick updates or newsletters.
 
 #### 2. [Sequences](/en/email-marketing/sequences)
 
 Automatically send a series of emails triggered by specific events in the system.
 
-## Next step
+## Next Step
 
-Learn [how to send broadcast emails](/en/email-marketing/broadcast-mails) to your audience.
+Learn [how to send broadcast emails](/en/email-marketing/broadcasts) to your audience.
 
-## Stuck somewhere?
+## Stuck Somewhere?
 
-We are always here for you. Come chat with us in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> channel or send a tweet at <a href="https://twitter.com/courselit" target="_blank">@CourseLit</a>.
+We are always here for you. Come chat with us in our <a href="https://discord.com/invite/GR4bQsN" target="_blank">Discord</a> channel or send a tweet to <a href="https://twitter.com/courselit" target="_blank">@CourseLit</a>.

apps/docs/src/pages/en/email-marketing/mail-access-request.md

@@ -32,7 +32,7 @@ Fill out the form and hit `Save`.
 
 ## Next step
 
-Let's see [how to send broadcast emails](/en/email-marketing/broadcast-mails).
+Let's see [how to send broadcast emails](/en/email-marketing/broadcasts).
 
 ## Stuck somewhere?