https://github.com/soumasish2005/toneshift
ToneShift is an AI-powered tool designed to transform the tone of your text to suit various contexts. It ensures your communication is clear, empathetic, and effective.
https://github.com/soumasish2005/toneshift
agent-based-modeling ai cloud firebase nlp react render text typescript
Last synced: 3 months ago
JSON representation
ToneShift is an AI-powered tool designed to transform the tone of your text to suit various contexts. It ensures your communication is clear, empathetic, and effective.
- Host: GitHub
- URL: https://github.com/soumasish2005/toneshift
- Owner: Soumasish2005
- Created: 2025-01-19T05:53:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-19T17:58:09.000Z (over 1 year ago)
- Last Synced: 2025-03-18T07:19:02.418Z (over 1 year ago)
- Topics: agent-based-modeling, ai, cloud, firebase, nlp, react, render, text, typescript
- Language: TypeScript
- Homepage: https://toneshift-five.vercel.app
- Size: 1.19 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ToneShift: AI-Powered Tone Transformation
Built as a part of the [GitHub Copilot Challenge ](https://dev.to/challenges/github), ToneShift is an AI-powered tool designed to transform the tone of your text to suit various contexts. Whether you need to adjust your message for professional, personal, or cultural purposes, ToneShift ensures your communication is clear, empathetic, and effective.
## Key Features
1. **Tone Transformation Options**
- Predefined tones: Professional, Empathetic, Motivational, Casual, Formal, Neutral.
- Automatic detection of the tone of the text via AI.
- Customizable tones for fine-tuning emotional intensity.
2. **Real-Time Integration**
- Works as a web application for transforming text.
- Provides real-time suggestions and edits as you type.
3. **Personalized Recommendations**
- Adapts to your preferences with machine learning over time.
- Saves and applies user-defined tone profiles.
## Use Cases
- **Professional Communication**: Convert casual messages into formal emails or transform critical feedback into constructive input.
- **Conflict Resolution**: Rewrite emotionally charged messages to ensure diplomacy and understanding.
- **Customer Support**: Handle customer queries or complaints with empathy and professionalism.
## Technology Stack
### **Frontend**
- **Framework**: React.js + Typescript
- **Styling**: Tailwind CSS, Lucide Reaxt for icons.
### **Backend**
- **Framework**: Node.js with Express.js
- **Hosting**: Render
### **AI/ML Engine**
- **NLP Models**: OpenAI GPT 4o, NVIDIA llama-3.1-nemotron-70b-instruct
### **Database**
- **Choice**: Firestore (NoSQL)
## Installation
### Prerequisites
1. Node.js (v14 or higher)
2. npm or yarn
### Steps
1. Clone the repository:
```bash
git clone https://github.com/yourusername/toneshift.git
cd toneshift
2. Install dependencies(both backend and frontend folders):
```bash
npm install
3. Set up environment variables:
- Create a .env file in the frontend directory.
- Add the following variables:
```
REACT_APP_FIREBASE_API_KEY=your_firebase_api_key
REACT_APP_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
REACT_APP_FIREBASE_PROJECT_ID=your_firebase_project_id
REACT_APP_FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
REACT_APP_FIREBASE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
REACT_APP_FIREBASE_APP_ID=your_firebase_app_id
```
- Create a .env file in the backend directory.
- Add the following variables:
```
NVIDIA_API_KEY=your_nvidia_api_key_for_the_required_model
4. Open the project:
```bash
npm run dev
5. Open the app in your browser at http://localhost:5173
### Usage
- Web App:
- Open the web app in your browser.
- Input text in the provided text box.
- Select the desired tone transformation.
- Preview and copy the transformed text.