Voice Recording App šļø
A modern and intuitive voice recording app built with React, React Router, and Tailwind CSS, designed for easy voice recording, playback, and management.
Table of Contents
- Features
- Tech Stack
- Installation
- Usage
- Contributing
- Credits
- License
Features
- Splash Screen: Interactive welcome screen with a modern design.
- Voice Recording: Start, stop, and save voice recordings easily.
- Timer Display: Live timer showing the recording duration.
- Recording List: Search and filter recordings with real-time updates.
- Download and Edit: Options to edit, delete, and download recordings.
- Responsive Design: Optimized for various screen sizes.
Tech Stack
- Frontend: React, React Router, React Icons
- Styling: Tailwind CSS
- State Management: React Context API
- Utilities: Custom Modals, Reusable Components
- react-media-recorder: for recording audios
Installation
Clone the Repository
git clone https://github.com/Brielle28/VoiceNote.git
cd VoiceNote
Install Dependencies
npm install
Start the Development Server
npm run dev
Usage
- Launch the app locally using
npm run dev
.
- Navigate through the screens:
- Splash Screen: Click 'Start' to proceed.
- Recording Screen: Use the record and stop buttons to create a recording.
- Voice List: Manage your saved recordings.
- Search for recordings using the search bar.
- Download or edit recordings from the list.
Folder Structure
src/
āāā components/
ā āāā audioFileList.jsx
ā āāā DeleteModal.jsx
ā āāā EditModal.jsx
āāā pages/
ā āāā SplashScreen.jsx
ā āāā Recording.jsx
ā āāā VoiceList.jsx
ā āāā VoiceMenu.jsx
āāā Context/
ā āāā UserProvider.jsx
āāā Utils/
ā āāā VoiceMenuList.js
ā āāā formatTime.js
āāā styles/
ā āāā Recording.css
ā āāā SplashScreen.css
āāā App.jsx
āāā index.jsx
Contributing
We welcome contributions! Follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature-name
.
- Commit your changes:
git commit -m "Add feature description"
.
- Push to the branch:
git push origin feature-name
.
- Open a Pull Request.
Credits
- Design: Inspired by modern recording apps.
- Icons: React Icons
- CSS Framework: Tailwind CSS
- react-media-recorder: npm react packages
License
This project is licensed under the MIT License. See the LICENSE file for details.