Skip to content

Amjum40/sparkles

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SHE_WANTS Banner

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

https://final-orcin-nine.vercel.app/

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)

![image ](Add screenshot 1 here with proper name) Add caption explaining what this shows

Screenshot2 Add caption explaining what this shows

Screenshot3 Add caption explaining what this shows

Diagrams

System Architecture:

Application Workflow:image

Additional Documentation

For Web Projects with Backend:

API Documentation Authentication

POST /api/auth/register

POST /api/auth/logineriod Tracking

GET /api/cycles/:userId POST /api/cycles DELETE /api/cycles/:cycleId

Pad Requests

POST /api/pad-request GET /api/pad-requests/nearby/:userId GET /api/pad-requests/my/:userId POST /api/pad-request/fulfill

ommunity Helpers

POST /api/helpers/register GET /api/helpers GET /api/helpers/status/:userId DELETE /api/helpers/:userId

sisterhood Posts

GET /api/posts POST /api/posts GET /api/posts/:postId POST /api/posts/:postId/like GET /api/posts/:postId/liked/:userId POST /api/posts/:postId/comment

AI Tools Used (Optional - For Transparency Bonus)

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

Tool Used: [antigravity]

Purpose: [What you used it for]

  • we had developed the backend for it

Key Prompts Used:

  • "integrating the google map authentification"
  • "real time tracking"
  • "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

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • HTML 49.3%
  • JavaScript 46.0%
  • CSS 4.7%