Vocl is a transcription platform prototype built as a technical challenge for Vocali, featuring a serverless AWS backend and a Nuxt frontend.
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
- Node.js
- TypeScript
- Serverless Framework
- AWS Lambda
- AWS Cognito
- DynamoDB
- S3
- Jest
- Nuxt 4
- TypeScript
- Tailwind CSS
- ESLint
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
- Node.js 20+
- pnpm 10+
- AWS credentials configured locally if you want to deploy the backend
From the project root:
pnpm installFrom the project root:
pnpm run formatpnpm run format:checkpnpm run lintpnpm run testpnpm run typecheckGitHub 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-lockfilepnpm run lintpnpm run testpnpm 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
At the current stage, the frontend and backend can be worked on separately.
Start the Nuxt dev server:
pnpm --filter frontend run devThen open:
http://localhost:3000
Run:
pnpm --filter backend run lintpnpm --filter backend run typecheckpnpm --filter backend run testThis verifies the Serverless configuration bundles correctly:
pnpm --filter backend exec serverless packageThe existing template hello function can be invoked locally with:
pnpm --filter backend exec serverless invoke local -f hello --path src/functions/hello/mock.jsonSpecial thanks to Vocali for the technical challenge guidelines that guided the development of this application.