SHE WANTS 🎯

Basic Details

Team Name: [SPARKLES]

Team Members

• Member 1: [RIYA ROSE ROY] - [NSSCE PALAKKAD]
• Member 2: [AMJUM SHAREEF] - [NSSCE PALAKKAD]

Hosted Project Link

[Your hosted link here]

Project Description

[WOMEN EMPOWERMENT - THE SITE WOULD BASED SOLUTION FOR THE ENTIRE GIRLS OF THE WORLD. THE GIRLS WOULD FACE ANXIETY, STRESS , AND DISTRESS IN THEIR PEROID TIME , SO IN ORDER TO THE MAKE SAFE . WE TEAM SPARKLES ENSURE THAT THE A SITE WHICH ENSURES THAT THE NO WOMEN WOULD FEEL UNSAFE OR BLAMED BECAUSE OF THIS REASONS . OUR MOTTO AND THEME IS FOR THAT THE WOMEN PROTECTION FOR IT.]

The Problem statement

[Many women face difficulty in managing menstrual health, especially in public spaces, colleges, workplaces, or during travel. Access to sanitary pads during emergencies is often limited, and asking for help can feel uncomfortable or unsafe. Additionally, existing period tracking applications do not provide real-time community-based emergency support while ensuring user privacy and safety.?]

The Solution

[We propose a women-friendly web platform that combines period tracking with an emergency support system. The platform allows users to track their menstrual cycle while also providing a feature to request sanitary pads in urgent situations. When a user requests help, the system accesses their current location (with permission) and notifies nearby verified users who are willing to help.

For user safety and privacy, the frontend initially appears as a simple calculator interface, ensuring discreet access. Only authenticated users can access the main features. This ensures safety, anonymity, and secure communication between users.

The platform promotes community support, menstrual awareness, and women empowerment through technology.?]

---

Technical Details

Technologies/ HTML, JS, GOOGLE MAP,SQLLITE

For Software:

• Languages used: [ JavaScript, Python, Java]
• Frameworks used: [ React, Django, Spring Boot]
• Libraries used: [e.g., axios, pandas, JUnit]
• Tools used: [ VS Code, GIT HUB]

---

Features

List the key features of your project:

• Feature 1: IT CONTAIN THE PEROID TRACKER FOR THE WOMEN
• Feature 2: [IT BASICALLY ADD THAT THE AND EMERGENCY BUTTON IF ANYBODY OF THE CONTAIN THE SANITARY NAPKINS IN IT]
• Feature 3: [CONTAIN THE SUPPORT SYSTEM FOR THE WOMEN NEEDED LIKE THE STRESS REILEF FOR THE USERS]
• Feature 4: [IT IS INTEGRATED WITH THE GOOGLE MAP AND HELP THE USER TO SHARE THE LOCATION]

---

Implementation

For Software:

Installation

[Installation commands - pm install and npm run dev]

### Build for Production
```bash
# Build frontend
npm run build

# Output will be in 'dist' folder

---

Project Documentation

For Software:

Screenshots (Add at least 3)

 Add caption explaining what this shows

 Add caption explaining what this shows

 Add caption explaining what this shows

Diagrams

System Architecture:

Explain your system architecture - components, data flow, tech stack interaction

Application Workflow:

Add caption explaining your workflow

---

For Hardware:

Schematic & Circuit

 Add caption explaining connections

 Add caption explaining the schematic

Build Photos


 List out all components shown

 Explain the build steps

 Explain the final build

---

Additional Documentation

For Web Projects with Backend:

API Documentation

Base URL: https://api.yourproject.com

Endpoints

GET /api/endpoint

• Description: [What it does]
• Parameters:
  • param1 (string): [Description]
  • param2 (integer): [Description]
• Response:

{
  "status": "success",
  "data": {}
}

POST /api/endpoint

• Description: [What it does]
• Request Body:

{
  "field1": "value1",
  "field2": "value2"
}

• Response:

{
  "status": "success",
  "message": "Operation completed"
}

[Add more endpoints as needed...]

---

For Mobile Apps:

App Flow Diagram

Explain the user flow through your application

Installation Guide

For Android (APK):

1. Download the APK from [Release Link]
2. Enable "Install from Unknown Sources" in your device settings:
   • Go to Settings > Security
   • Enable "Unknown Sources"
3. Open the downloaded APK file
4. Follow the installation prompts
5. Open the app and enjoy!

For iOS (IPA) - TestFlight:

1. Download TestFlight from the App Store
2. Open this TestFlight link: [Your TestFlight Link]
3. Click "Install" or "Accept"
4. Wait for the app to install
5. Open the app from your home screen

Building from Source:

# For Android
flutter build apk
# or
./gradlew assembleDebug

# For iOS
flutter build ios
# or
xcodebuild -workspace App.xcworkspace -scheme App -configuration Debug

---

For Hardware Projects:

Bill of Materials (BOM)

Component	Quantity	Specifications	Price	Link/Source
Arduino Uno	1	ATmega328P, 16MHz	₹450	[Link]
LED	5	Red, 5mm, 20mA	₹5 each	[Link]
Resistor	5	220Ω, 1/4W	₹1 each	[Link]
Breadboard	1	830 points	₹100	[Link]
Jumper Wires	20	Male-to-Male	₹50	[Link]
[Add more...]

Total Estimated Cost: ₹[Amount]

Assembly Instructions

Step 1: Prepare Components

1. Gather all components listed in the BOM
2. Check component specifications
3. Prepare your workspace Caption: All components laid out

Step 2: Build the Power Supply

1. Connect the power rails on the breadboard
2. Connect Arduino 5V to breadboard positive rail
3. Connect Arduino GND to breadboard negative rail Caption: Power connections completed

Step 3: Add Components

1. Place LEDs on breadboard
2. Connect resistors in series with LEDs
3. Connect LED cathodes to GND
4. Connect LED anodes to Arduino digital pins (2-6) Caption: LED circuit assembled

Step 4: [Continue for all steps...]

Final Assembly: Caption: Completed project ready for testing

---

For Scripts/CLI Tools:

Command Reference

Basic Usage:

python script.py [options] [arguments]

Available Commands:

• command1 [args] - Description of what command1 does
• command2 [args] - Description of what command2 does
• command3 [args] - Description of what command3 does

Options:

• -h, --help - Show help message and exit
• -v, --verbose - Enable verbose output
• -o, --output FILE - Specify output file path
• -c, --config FILE - Specify configuration file
• --version - Show version information

Examples:

# Example 1: Basic usage
python script.py input.txt

# Example 2: With verbose output
python script.py -v input.txt

# Example 3: Specify output file
python script.py -o output.txt input.txt

# Example 4: Using configuration
python script.py -c config.json --verbose input.txt

Demo Output

Example 1: Basic Processing

Input:

This is a sample input file
with multiple lines of text
for demonstration purposes

Command:

python script.py sample.txt

Output:

Processing: sample.txt
Lines processed: 3
Characters counted: 86
Status: Success
Output saved to: output.txt

Example 2: Advanced Usage

Input:

{
  "name": "test",
  "value": 123
}

Command:

python script.py -v --format json data.json

Output:

[VERBOSE] Loading configuration...
[VERBOSE] Parsing JSON input...
[VERBOSE] Processing data...
{
  "status": "success",
  "processed": true,
  "result": {
    "name": "test",
    "value": 123,
    "timestamp": "2024-02-07T10:30:00"
  }
}
[VERBOSE] Operation completed in 0.23s

---

Project Demo

Video

[Add your demo video link here - YouTube, Google Drive, etc.]

Explain what the video demonstrates - key features, user flow, technical highlights

Additional Demos

[Add any extra demo materials/links - Live site, APK download, online demo, etc.]

---

AI Tools Used (Optional - For Transparency Bonus)

If you used AI tools during development, document them here for transparency:

Tool Used: [e.g., GitHub Copilot, v0.dev, Cursor, ChatGPT, Claude]

Purpose: [What you used it for]

• Example: "Generated boilerplate React components"
• Example: "Debugging assistance for async functions"
• Example: "Code review and optimization suggestions"

Key Prompts Used:

• "Create a REST API endpoint for user authentication"
• "Debug this async function that's causing race conditions"
• "Optimize this database query for better performance"

Percentage of AI-generated code: [Approximately X%]

Human Contributions:

• Architecture design and planning
• Custom business logic implementation
• Integration and testing
• UI/UX design decisions

Note: Proper documentation of AI usage demonstrates transparency and earns bonus points in evaluation!

---

Team Contributions

• [RIYA ROSE ROY]: [BACKEND - API INTEGRATION OF THE GOOGLE AMP]
• [AMJUM SHAREEF]: [FRONTEND- UI OF THE APP]

---

License

This project is licensed under the [LICENSE_NAME] License - see the LICENSE file for details.

Common License Options:

• MIT License (Permissive, widely used)
• Apache 2.0 (Permissive with patent grant)
• GPL v3 (Copyleft, requires derivative works to be open source)

---

Made with ❤️ at TinkerHub