{"id":15792951,"url":"https://github.com/ayushsoni1010/voice-wave","last_synced_at":"2026-01-21T16:31:13.408Z","repository":{"id":237045778,"uuid":"793377529","full_name":"ayushsoni1010/voice-wave","owner":"ayushsoni1010","description":null,"archived":false,"fork":false,"pushed_at":"2024-04-29T17:40:26.000Z","size":1004,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-11T23:22:49.095Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ayushsoni1010.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-29T05:38:12.000Z","updated_at":"2024-04-29T17:40:30.000Z","dependencies_parsed_at":"2024-04-29T19:07:06.542Z","dependency_job_id":null,"html_url":"https://github.com/ayushsoni1010/voice-wave","commit_stats":null,"previous_names":["ayushsoni1010/voice-wave"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayushsoni1010%2Fvoice-wave","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayushsoni1010%2Fvoice-wave/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayushsoni1010%2Fvoice-wave/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ayushsoni1010%2Fvoice-wave/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ayushsoni1010","download_url":"https://codeload.github.com/ayushsoni1010/voice-wave/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247631832,"owners_count":20970069,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-04T23:07:25.832Z","updated_at":"2026-01-21T16:31:13.374Z","avatar_url":"https://github.com/ayushsoni1010.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Voice Notes Web App Test\n\nThis test aims to assess your ability to create a voice notes web application that utilizes real-time audio streaming and transcription. The task involves implementing a user-friendly interface where users can record their voice, view their live transcription, edit their transcription, and copy or clear it as needed.\n\n![Example](example.gif)\n\n## Task Details\n\n### Implementation Checklist\n\n- [ ] **Stream Audio:** Stream the recorded audio to the server for real-time transcription using WebSocket (Socket.IO) library.\n- [ ] **Live Transcription:** Implement real-time transcription of the user's voice using Deepgram Transcription API.\n- [ ] **Display Transcription:** Display the live transcription in a text area, allowing the user to see what they are saying in real-time.\n- [ ] **Edit Transcription:** Allow the user to manually edit the transcription in the text area.\n- [ ] **Copy Transcription:** Add a copy button that allows the user to easily copy the transcription to the clipboard.\n- [ ] **Clear Transcription:** Add a clear button that resets the transcription and clears the text area.\n- [ ] **Create Attractive UI:** Design and implement a visually appealing and intuitive user interface for the web app.\n\n### Transcription API Integration\n\n- The web app should integrate with Deepgram Transcription API to perform real-time transcription of the user's voice.\n- The server-side implementation should handle the communication with the transcription API, including sending the audio stream and receiving transcription events.\n- The client-side implementation should display the transcription events in real-time as they are received from the server.\n\n### Audio Streaming with WebSocket (Socket.IO)\n\n- Use the WebSocket (Socket.IO) library to establish a real-time bidirectional communication channel between the client and the server.\n- Utilize the WebSocket connection to stream the recorded audio from the client to the server in real-time.\n- The server should receive the audio stream and forward it to the transcription API for real-time transcription.\n\n### UI Design\n\n- The UI should be designed to match the look and feel of the Speechify website.\n- Use similar colors, theming, and visual elements to create a consistent user experience.\n- Be creative in your implementation and feel free to add your own unique touch to the UI while staying true to the Speechify brand.\n- The implementation of the UI is flexible, so you have the freedom to make design decisions that enhance the user experience and functionality of the web app.\n\n### Provided Code\n\n- We provide the `useAudioRecorder` file to handle the audio recording events.\n- The `useAudioRecorder` file abstracts away the complexity of audio recording, allowing you to focus on streaming the audio and implementing the transcription features.\n\n## Setup\n\n- Clone the repository.\n- Navigate to the client directory and run the following commands:\n  ```\n  cd client\n  npm install\n  npm run dev\n  ```\n- In a separate terminal window, navigate to the server directory and run the following commands:\n  ```\n  cd server\n  npm install\n  npm run dev\n  ```\n\n### Server-side Implementation\n\n- Implement the server-side logic to handle the WebSocket connection and audio streaming.\n- Use the Socket.IO library to establish a WebSocket connection between the client and the server.\n- Receive the audio stream from the client via the WebSocket connection and send it to the transcription API for real-time transcription.\n- Subscribe to the transcription events provided by the API and emit them to the client via the WebSocket connection.\n\n### Client-side Implementation\n\n- Utilize the provided `useAudioRecorder` file to handle audio recording events.\n- Implement the client-side logic to establish a WebSocket connection with the server using the Socket.IO library.\n- Stream the recorded audio to the server via the WebSocket connection in real-time.\n- Listen for transcription events emitted by the server:\n  - Display the interim transcription results in the text area as they are received, allowing the user to see the real-time transcription progress.\n  - When the final transcription results are received, replace the interim results in the text area with the final transcription.\n- Allow the user to manually edit the transcription in the text area.\n- Implement a copy button that allows the user to easily copy the transcription to the clipboard.\n- Add a clear button that resets the transcription and clears the text area.\n\n## Automatic Testing\n\nTo facilitate testing of the web app, please make sure to add the following IDs to the corresponding UI components:\n\n- Record Button: Add the ID `record-button` to the button element that starts and stops the audio recording.\n  Example: `\u003cbutton id=\"record-button\"\u003eRecord\u003c/button\u003e`\n\n- Transcription Display: Add the ID `transcription-display` to the element that displays the real-time transcription.\n  Example: `\u003ctextarea id=\"transcription-display\"\u003e\u003c/textarea\u003e`\n\n- Copy Button: Add the ID `copy-button` to the button element that copies the transcription to the clipboard.\n  Example: `\u003cbutton id=\"copy-button\"\u003eCopy\u003c/button\u003e`\n\n- Clear Button: Add the ID `reset-button` to the button element that clears the transcription.\n  Example: `\u003cbutton id=\"reset-button\"\u003eClear\u003c/button\u003e`\n\nBy adding these IDs to the respective UI components, the provided test suite will be able to locate and interact with the elements correctly.\n\n---\n\n## Development Guidelines\n\n### Do's\n\n- Write clean, maintainable, and well-documented code and follow the best practices and coding standards.\n- You are free to use any official documentation or language references (MDN, React Docs, Socket.IO Docs, etc).\n- You can use the debugging tools and native IDE features (only standard Auto-Completion).\n- Implement robust error handling and graceful error recovery mechanisms throughout the application to ensure a smooth user experience and maintain the stability of the web app.\n\n### Don'ts\n\n- Do NOT use any external libraries for the implementation, except for any previously mentioned or already installed sdks.\n- DO NOT include any API keys or sensitive information in the client-side code.\n- DO NOT use any Coding Assistants like GitHub Copilot, ChatGPT, etc., or any other AI-based tools.\n- DO NOT visit direct blogs or articles related to the implementation of the tasks.\n- DO NOT use Stack Overflow or any other forum websites.\n- DO NOT submit your Deepgram key in your final solution (keep in .env file). We will use our own when auto-grading.\n\n## Resources\n\n- Socket IO documentation: https://socket.io/docs/v4/\n- Socket IO client sdk: https://www.npmjs.com/package/socket.io-client\n- Socket IO server sdk: https://www.npmjs.com/package/socket.io-client\n- Deepgram documentation: https://developers.deepgram.com/docs/node-sdk-streaming-transcription\n- Deepgram sdk: https://www.npmjs.com/package/@deepgram/sdk\n- Deepgram signup (for free API key): https://console.deepgram.com/signup\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayushsoni1010%2Fvoice-wave","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fayushsoni1010%2Fvoice-wave","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fayushsoni1010%2Fvoice-wave/lists"}