https://github.com/indexposition/silencesense
https://github.com/indexposition/silencesense
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/indexposition/silencesense
- Owner: IndexPosition
- Created: 2024-08-28T12:07:15.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T21:26:25.000Z (9 months ago)
- Last Synced: 2025-01-14T05:50:59.624Z (4 months ago)
- Language: JavaScript
- Homepage: https://silence-sense.vercel.app
- Size: 903 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# SilenceSense
SilenceSense is a web application that detects silences in audio files using **Voice Activity Detection (VAD)**. The project consists of a React frontend for the user interface and a Flask backend for processing audio files.
## Table of Contents
- [Prerequisites](#prerequisites)
- [Backend Setup](#backend-setup)
- [Frontend Setup](#frontend-setup)
- [Running the Application](#running-the-application)
- [Testing](#testing)
- [Deployment](#deployment)
## Prerequisites
Ensure you have the following installed:
- Python 3.x
- Node.js and npm (or Yarn)
## Backend Setup
1. **Clone the repository:**
```bash
git clone https://github.com/yourusername/silencesense.git
cd silencesense
```
2. **Navigate to the `backend` directory:**
```bash
cd backend
```
3. **Install the required Python packages:**
```bash
pip install -r requirements.txt
```
4. **Run the Flask application:**
```bash
python app.py
```
The backend will be running on `http://localhost:5000`.
## Frontend Setup
1. **Navigate to the `frontend` directory:**
```bash
cd ../frontend
```
2. **Install the required Node.js packages:**
```bash
npm install
```
Or if you use Yarn:
```bash
yarn install
```
3. **Start the React application:**
```bash
npm start
```
Or if you use Yarn:
```bash
yarn start
```
The frontend will be running on `http://localhost:3000`.
## Running the Application
1. Ensure both the Flask backend and the React frontend are running.
2. Open your browser and go to `http://localhost:3000` to interact with the application.
## Testing
For testing the backend, you can use tools like `curl` or Postman to send requests to the Flask API.
For frontend testing, use the built-in React testing utilities or other libraries like Jest.
## Deployment
To deploy the application, consider the following steps:
1. **Backend Deployment:**
- Use platforms like Heroku, AWS, or Google Cloud to host the Flask application.
2. **Frontend Deployment:**
- Deploy the React application using Vercel, Netlify, or any static site hosting service.
3. **Configure Environment Variables:**
- Ensure that environment variables for production are set correctly in both the frontend and backend deployments.