Meetlytic

Automate the transcription and summarization of virtual meetings

1. Introduction

1.1 Useful Links

• Pay attention, that we have certain quality criteria, which we should follow during application development.

TODO: Add development deployment link

2. Domain

The product helps the users to automate the transcription and summarization of virtual meetings (Zoom, Google Meet, MS Teams), enabling users to focus on discussions rather than note-taking

3. Requirements

• NodeJS (22.x.x);
• npm (10.x.x);
• PostgreSQL (17.5)

4. Database Schema

erDiagram
   users {
      int id PK
      string email UK
      text password_hash
      text password_salt
      dateTime created_at
      dateTime updated_at
   }
   user_details {
      int id PK
      string first_name
      string last_name
      int user_id FK
      int avatar_file_id FK "nullable"
      dateTime created_at
      dateTime updated_at
   }
   meetings {
      int id PK
      text instance_id
      enum host "Values: 'zoom'"
      enum status "Values: 'ended', 'started'"
      int owner_id FK
      text meeting_id
      text meeting_password
      text summary
      text action_items
      int audio_file_id FK
      dateTime created_at
      dateTime updated_at
   }
   files {
      int id PK
      text key UK
      text url
      text content_type
      dateTime created_at
      dateTime updated_at
   }
   meeting_transcriptions {
      int id PK
      int meeting_id FK
      text chunk_text
      dateTime created_at
      dateTime updated_at
   }
   users ||--|| user_details: user_id
   users ||--o{ meetings: owner_id
   meetings }o--|| files: audio_file_id
   meetings ||--o{ meeting_transcriptions: meeting_id
   user_details }o--|| files : avatar_file_id

Loading

5. Architecture

TODO: add application schema

5.1 Global

5.1.1 Technologies

1. Typescript
2. npm workspaces

5.2 Frontend

5.2.1 Technologies

1. React — a frontend library
2. Redux + Redux Toolkit — a state manager

5.2.2 Folder Structure

1. assets - static assets (images, global styles)

2. libs - shared libraries and utilities

   2.1 components - plain react components

   2.2 enums

   2.3 helpers

   2.4 hooks

   2.5 modules - separate features or functionalities

   2.6 types

3. modules - separate app features or functionalities

4. pages - app pages

5.3 Backend

5.3.1 Technologies

1. Fastify — a backend framework
2. Knex — a query builder
3. Objection — an ORM

5.3.2 Folder Structure

1. db - database data (migrations, seeds)

2. libs - shared libraries and utilities

   2.1 enums

   2.2 exceptions

   2.3 helpers

   2.4 modules - separate features or functionalities

   2.5 types

3. modules - separate app features or functionalities

5.4 Bot

5.4.1 Technologies

1. Puppeteer — API to automate Chrome

5.5 Shared Package

5.5.1 Reason

As we are already using js on both frontend and backend it would be useful to share some contracts and code between them.

5.5.2 Technologies

1. Zod — a schema validator

6. How to Run

6.1 Manually

1. Create and fill all .env files. These files are:

• apps/frontend/.env
• apps/backend/.env
• apps/bot/.env

You should use .env.example files as a reference.

2. Install dependencies: npm install.

3. Install pre-commit hooks: npx simple-git-hooks. This hook is used to verify code style on commit.

4. Run database. You can run it by installing postgres on your computer.

5. Apply migrations: npm run migrate:dev -w apps/backend

6. Run backend: npm run start:dev -w apps/backend

7. Run frontend: npm run start:dev -w apps/frontend

7. Development Flow

7.1 Pull Request Flow

<type>: <ticket-title> <project-prefix>-<issue-number>

For the full list of types check Conventional Commits

Examples:

• feat: add dashboard screen ml-123

7.2 Branch Flow

<issue-number>-<type>-<short-desc>

Examples:

• 123-feat-add-dashboard
• 12-feat-add-user-flow
• 34-fix-user-flow

7.3 Commit Flow

We use Conventional Commits to handle commit messages

<type>: <description> <project-prefix>-<issue-number>

Examples:

• feat: add dashboard component ml-45
• fix: update dashboard card size ml-212

8. Deployment

CI/CD implemented using GitHub Actions