NoteScribe

A web-tool using AI to transcribe and translate from audio/speech to text.

Link to project: NoteScribe

Table of Contents

• About me
• Highlights
• Built With
• Getting Started
  • Prerequisites
  • Installation
  • Usage
• Future Enhancement Roadmap
• Feedback and Contributions
• License
• Contacs

🚀 About me

Hi, I'm Huy Phung – welcome to my senior project at DePauw University, a NoteScribe that focused on helping people with hearing impairments by providing an easy way to transcribe and translate audio recordings

Inspired by Hugging Face, NoteScribe was created to address the need for a simple, accessible, and feature-rich tool to manage voice notes. From students and professionals to anyone needing efficient note management, this app aims to streamline the process of capturing and organizing audio recordings.

Whether you're recording a lecture, a meeting, or your personal thoughts, NoteScribe provides an all-in-one platform to transcribe, translate, and manage your notes with ease.

🌟 Highlights:

• Audio Transcription: Automatically transcribe recorded or uploaded audio files into text with high accuracy
• Multiple Language Support: Transcribe audio in various languages and translate transcriptions into over 50 languages.
• File Upload for Transcription: Upload pre-recorded audio files for quick and accurate text conversion.
• Export Transcriptions: Save transcribed text as documents or copy them for future use.
• Audio Playback with Text Syncing: Review audio and synced text side by side for seamless editing and note-taking.

🔨 Built With:

📝 Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Make sure you have the following installed on your local machine:

• Node.js
• npm (Node Package Manager)

Installation

1. Clone the repo

   git clone https://github.com/your-username/notescribe.git

2. Navigate to the project directory

   cd notescribe

3. Install NPM packages

   npm install

4. Start the development client and server

   npm run dev

Usage

1. Open your browser and navigate to http://localhost:5173
2. Upload an audio file or record a new one to start transcribing.

🔑 Future Enhancement Roadmap:

• [ ] Dark mode/ System mode
• [ ] User Authentication and Authorization
  • [x] JWT
  • [x] Role-Based Access Control (RBAC)
  • [ ] OAuth 2.0
  • [ ] Multi-Factor Authentication (MFA)
• [x] Responsiveness with mobile view
• [x] Integration with Cloud Storage Services
• [ ] Enhanced Security Features
  • [ ] Data Encryption at Rest and in Transit
  • [ ] Regular Security Audits and Penetration Testing
  • [ ] Secure API Endpoints with Rate Limiting
  • [ ] Implement Content Security Policy (CSP)
• [ ] Customizable Transcription Settings
  • [ ] Transcription Accuracy Levels
  • [ ] Timestamp Insertion
• [ ] Advanced Analytics and Reporting (Admin Dashboard)
  • [ ] Usage Statistics
  • [ ] User Behavior Analysis
  • [ ] Performance Reports
  • [ ] Custom Reports

🤝 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📃 License

Distributed under the MIT License.

🗨️ Contacts

Huy Phung - huyphung3103@gmail.com

Project Link: https://github.com/hphng/NoteScribe