- What Even is SHE?
- Tech Stack That Powers Us
- Features to Keep You Safe
- How it Works (And How We Get You Out of Trouble)
- Installation Guide for Brave Ssouls
- Usage - How to Save Your Skin
- Because We Care About Security
- Roadmap to World Domination
- License? Sure, Take it
You know that feeling when you’re staying late at work, and suddenly your phone dies, and your boss is giving you creepy vibes? (We see you 👀). Yeah, that's when SHE comes to your rescue. SHE is your personal superhero 🦸♀️, disguised as a discreet web app that shares your live location, records audio, and lets you file complaints directly to the Tamil Nadu Police. Oh, and don't worry, we’ve made sure it’s as sneaky as your ex during a breakup.
Because you know this isn't some lame project from 2015...
- Next.js: Because SPAs are so last year. Server-side rendering? Yes, please!
- TypeScript: Strong types for stronger women 💪.
- Tailwind CSS: Faster styling because safety shouldn't have to wait. Plus, who has time for writing CSS from scratch anymore?
- Gemini API: Giving us the real-time superpower to track your location.
- OpenAI API: Nope, this isn't Skynet (yet), but the AI helps make things even more magical.
- Live Location Sharing: Sends your location to your loved ones faster than you can say, "Where's my phone charger?"
- Audio Recording: Get the evidence you need without raising suspicions. Perfect for when things start feeling fishy 🐟.
- Police Complaint: File a complaint directly through the Tamil Nadu Police Portal. Yes, this is legit.
- OpenAI-Powered Alerts: No, we don't have Jarvis. But this AI helps you send alerts intelligently, because why not use AI to keep you safe?
- Invisible Mode: Because no one needs to know you're hitting that SOS button (except the people who need to).
- Registration: Create an account, add your emergency contacts (we recommend family over Tinder dates).
- Emergency Mode: If you feel unsafe, hit that emergency button like you're hitting snooze on a Monday morning.
- Live Location Sharing: Your location gets shared with your contacts and authorities, updating in real-time. Take that, creeps.
- Audio Recording: The app will quietly start recording, and store that juicy evidence securely on the cloud. Because, receipts!
- Police Complaint: One tap to submit a complaint. You'll be thanking us later.
- AI Assistance: The app can analyze the situation and help alert the right people (your dad, best friend, and the authorities).
- Node.js
- Your bravery (and coffee, because let’s be real)
- Clone this gem of a project:
git clone https://github.com/brittytino/SHE.git
- Move into the project directory (because why else would you clone it?):
cd SHE - Install the required dependencies like the responsible developer you are:
npm install
- Set up your environment variables for Firebase, Gemini API, OpenAI API, and the Tamil Nadu Police Portal (this is where things get real).
- Run the development server:
Boom. You’re ready.
npm run dev
- Sign Up: Input your details (don’t worry, we keep them safer than your Instagram DMs).
- Hit the Button: When you’re in a sketchy situation, trigger the emergency mode. It's as simple as ordering pizza online.
- Let Us Do the Work: We’ll handle the live location, audio recording, and alerting the authorities like pros.
Security is like sunscreen—crucial but often ignored until it's too late. So, here’s what we’ve done:
- Data Encryption: Your location, audio, and personal data are encrypted with AES-256 (yeah, the military-grade stuff).
- HTTPS: Because we're fancy like that.
- Token-Based Authentication: Keeping unauthorized access out of your (digital) purse.
- Voice Activation: Because shouting “HELP!” should do more than just scare the cat.
- State-Wide Expansion: Tamil Nadu is just the start. World domination is next.
- AI-Powered Risk Detection: We’re building algorithms that can predict risk before you even realize you’re in trouble.
This project is licensed under the MIT License—meaning you're free to use, modify, and distribute it. Just don’t go using it for evil stuff, okay?
SHE - Because You Deserve to Feel Safe, Anytime, Anywhere.