8000 GitHub - lu-jim/vocl · GitHub
[go: up one dir, main page]

Skip to content
lu-jimPublic

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Vocl

Vocl is a transcription platform prototype built as a technical challenge for Vocali, featuring a serverless AWS backend and a Nuxt frontend.

Project goals

The platform currently supports:

  • user registration
  • user authentication
  • logout
  • audio file transcription for files up to 20 MB
  • real-time transcription from the computer microphone
  • saving finalized live transcript text into history
  • transcription history with pagination
  • transcription download

Tech stack

Backend

  • Node.js
  • TypeScript
  • Serverless Framework
  • AWS Lambda
  • AWS Cognito
  • DynamoDB
  • S3
  • Jest

Frontend

  • Nuxt 4
  • TypeScript
  • Tailwind CSS
  • ESLint

Repository structure

vocl/
├── backend/
│   ├── serverless.ts
│   ├── package.json
│   ├── src/
│   │   ├── functions/
│   │   │   ├── hello/
│   │   │   ├── upload/
│   │   │   ├── transcribe/
│   │   │   ├── history/
│   │   │   ├── download/
│   │   │   ├── realtime-token/
│   │   │   └── realtime-save/
│   │   └── libs/
│   └── tests/
├── frontend/
│   ├── app.vue
│   ├── components/
│   │   ├── AudioUploader.vue
│   │   └── RealtimeRecorder.vue
│   ├── pages/
│   │   ├── dashboard.vue
│   │   └── history.vue
│   ├── nuxt.config.ts
│   └── package.json
├── .github/
│   └── workflows/
│       └── ci.yml
├── package.json
└── README.md

Requirements

  • Node.js 20+
  • pnpm 10+
  • AWS credentials configured locally if you want to deploy the backend

Installation

From the project root:

pnpm install

Workspace commands

From the project root:

Format

pnpm run format

Check formatting

pnpm run format:check

Lint everything

pnpm run lint

Run backend tests

pnpm run test

Typecheck all workspaces

pnpm run typecheck

CI

GitHub Actions runs the baseline validation workflow in .github/workflows/ci.yml on pushes to main and on pull requests.

The workflow currently runs:

  • pnpm install --frozen-lockfile
  • pnpm run lint
  • pnpm run test
  • pnpm run typecheck

This gives automated coverage for:

  • backend unit tests under backend/tests/unit
  • backend and frontend linting
  • backend TypeScript checks and Nuxt frontend typechecking

Current gaps:

  • no frontend component/unit test harness yet
  • no E2E/browser test suite yet
  • no deploy job in CI

How to run the project manually right now

At the current stage, the frontend and backend can be worked on separately.

Frontend

Start the Nuxt dev server:

pnpm --filter frontend run dev

Then open:

http://localhost:3000

Backend

Validate the backend code

Run:

pnpm --filter backend run lint
pnpm --filter backend run typecheck
pnpm --filter backend run test

Package the backend

This verifies the Serverless configuration bundles correctly:

pnpm --filter backend exec serverless package

Invoke the example function locally

The existing template hello function can be invoked locally with:

pnpm --filter backend exec serverless invoke local -f hello --path src/functions/hello/mock.json

Acknowledgments

Special thanks to Vocali for the technical challenge guidelines that guided the development of this application.

About

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages

0