Skip to content

Update README.md #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 26 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,86 +1,62 @@
# [Project Name] 🎯
#Travel E Hoa 🎯


## Basic Details
### Team Name: [Name]
## Text-Based Communication: Clear, easy-to-read written content to accommodate those who rely on reading instead of auditory information.
## Speech-to-Text Tools: Features that convert spoken words into written text in real-time, allowing users to communicate without speaking.
### Team Name: Clock_Out


### Team Members
- Member 1: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Member 1: Meera Govind - Sree Narayana Gurukulam College of Engineering
- Member 2: Risna Jaleel- Sree Narayana Gurukulam College of Engineering

### Hosted Project Link
[mention your project hosted project link here]
statuesque-piroshki-a503a1.netlify.app

### Project Description
[2-3 lines about what your project does]
The primary mission of this website is to create an online environment where communication barriers are reduced, and everyone, regardless of their ability to hear or speak, can access, participate, and connect. The project aims to empower individuals to express themselves fully, access vital information, and engage in a supportive community of peers.

By providing these resources and tools, the website will foster independence, increase accessibility, and help bridge communication gaps for people who are deaf, hard of hearing, or non-verbal.
### The Problem statement
[What ridiculous problem are you solving?]
The ability to quickly and clearly alert someone to an emergency, no matter their ability to hear or speak, makes the website not only accessible but life-saving in critical moments. It's ridiculous that these simple safety features aren't standard on all platforms already—so having it here would be a huge step forward in making the internet a truly inclusive and safe space

### The Solution
[How are you solving it? Keep it fun!]
Real-Time Alerts: In case of an emergency, the website would have a dedicated notification system that sends alerts to all users in real time. It could notify users about natural disasters, safety concerns, or any immediate actions they need to take.
For Users Who Can’t Hear: When someone speaks, the website can transcribe their speech into text in real time, allowing those who are deaf or hard of hearing to follow the conversation without missing out on important details. This would be invaluable for webinars, meetings, or casual chats.

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]

For Hardware:
- [List main components]
- [List specifications]
- [List tools required]
- Python
- HTML
- googletrans, flask,from flask_cors,from geopy.geocoders

### Implementation
For Software:
# Installation
[commands]

Install the all necessary libraries
# Run
[commands]

python.py,index.html in live server
Comment on lines +30 to +39
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Enhance technical documentation for better onboarding.

The current technical documentation lacks essential details for setting up and running the project.

### Technologies/Components Used
For Software:
- Python
- HTML
-googletrans, flask,from flask_cors,from geopy.geocoders
+- Flask (Web Framework)
+- googletrans (Translation)
+- flask-cors (CORS support)
+- geopy (Geocoding)

### Implementation
-# Installation
-Install the all necessary libraries
-# Run
-python.py,index.html in live server
+## Prerequisites
+- Python 3.8 or higher
+- pip (Python package manager)
+
+## Installation
+1. Clone the repository
+   ```bash
+   git clone [repository-url]
+   cd [repository-name]
+   ```
+
+2. Install dependencies
+   ```bash
+   pip install -r requirements.txt
+   ```
+
+## Running the Application
+1. Start the Python backend
+   ```bash
+   python app.py
+   ```
+
+2. Open the frontend
+   ```bash
+   # Using VS Code Live Server or any HTTP server
+   # Open index.html in your browser
+   ```
🧰 Tools
🪛 LanguageTool

[uncategorized] ~39-~39: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ry libraries # Run python.py,index.html in live server ### Project Documentation F...

(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)

### Project Documentation
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
![image](https://github.com/user-attachments/assets/d36d57f4-0d93-4147-8f11-f3ff77d57366)

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*

For Hardware:
https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.researchgate.net%2Ffigure%2FText-To-Speech-system-architecture_fig1_241025907&psig=AOvVaw3PsFTcCHsudeb9lJAca1yb&ust=1737957205954000&source=images&cd=vfe&opi=89978449&ved=0CBQQjRxqFwoTCNDL16XZkosDFQAAAAAdAAAAABAE

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*
# Build Photo

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*

# Build Photos
![Team](Add photo of your team here)
![image](https://github.com/user-attachments/assets/ad72c589-543d-494e-999d-7b75b6017ae2)


![Components](Add photo of your components here)
*List out all components shown*
![image](https://github.com/user-attachments/assets/9087ed3d-a701-492a-b176-613edbfd19b5)
ld process here)

![Build](Add photos of build process here)
*Explain the build steps*

![Final](Add photo of final product here)
*Explain the final build*
![image](https://github.com/user-attachments/assets/c0b45a16-2454-4bd4-a93f-b5d9d2b43097)
Comment on lines +44 to +59
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Improve documentation structure and image hosting.

Several issues need attention in the documentation section:

  1. Image links use GitHub user-attachments which might not be accessible
  2. Contains a bare URL for diagram
  3. Has incomplete content ("ld process here")

Consider the following improvements:

  1. Host images in the repository's assets folder
  2. Properly format the diagram link as Markdown
  3. Remove incomplete content
# Screenshots
-![image](https://github.com/user-attachments/assets/d36d57f4-0d93-4147-8f11-f3ff77d57366)
+![Homepage](./assets/images/homepage.png)

# Diagrams
-https://www.google.com/url?sa=i&url=https%3A%2F%2Fwww.researchgate.net%2Ffigure%2FText-To-Speech-system-architecture_fig1_241025907&psig=AOvVaw3PsFTcCHsudeb9lJAca1yb&ust=1737957205954000&source=images&cd=vfe&opi=89978449&ved=0CBQQjRxqFwoTCNDL16XZkosDFQAAAAAdAAAAABAE
+![Text-To-Speech Architecture](./assets/images/tts-architecture.png)

-# Build Photo
-![image](https://github.com/user-attachments/assets/ad72c589-543d-494e-999d-7b75b6017ae2)
-![image](https://github.com/user-attachments/assets/9087ed3d-a701-492a-b176-613edbfd19b5)
-ld process here)
-![image](https://github.com/user-attachments/assets/c0b45a16-2454-4bd4-a93f-b5d9d2b43097)
+# Application Screenshots
+![Feature 1](./assets/images/feature1.png)
+![Feature 2](./assets/images/feature2.png)
+![Feature 3](./assets/images/feature3.png)

Committable suggestion skipped: line range outside the PR's diff.

🧰 Tools
🪛 Markdownlint (0.37.0)

47-47: Bare URL used
null

(MD034, no-bare-urls)


### Project Demo
# Video
Expand All @@ -91,9 +67,8 @@ For Hardware:
[Add any extra demo materials/links]

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- Meera :made a remarkable effort on coding and implementaion
- Risna : made a remarkable contribution on giving ideas

---
Made with ❤️ at TinkerHub