🌸 Aarini

Your AI-Powered Women's Hormonal Wellness & Period Health Companion

Aarini — Meaning "bringer of light" — is a compassionate, intelligent, and privacy-first health companion built to help every woman understand her body, honor her cycle, and thrive at every phase of life.

## 📖 Table of Contents

✨ About Aarini
💡 Why Aarini Exists
🚀 Key Features
🛠️ Tech Stack
🏗️ Architecture
📁 Project Structure
⚙️ Installation Guide
🔐 Environment Variables
📡 API Reference
🗺️ Roadmap
🤝 Contributing
🌍 Open Source
🔮 Future Vision
📄 License
💜 Closing Note

✨ About Aarini

Aarini is an AI-powered women's hormonal wellness and period health companion — built with empathy, powered by intelligence, and designed to put women in control of their own health narratives.

From tracking cycles and logging daily symptoms to receiving personalized wellness insights and chatting with a compassionate AI health assistant, Aarini is the all-in-one digital companion that treats women's health not as an afterthought — but as a priority.

Whether you're navigating irregular cycles, understanding PMS patterns, or simply trying to be more in tune with your body, Aarini walks beside you — every single day of every phase.

💡 Why Aarini Exists

Women's hormonal health is one of the most underserved and under-researched areas in modern medicine and technology.

🩺 1 in 10 women worldwide lives with PCOS — many undiagnosed
📊 80% of women experience PMS symptoms, yet struggle to communicate them to healthcare providers
💬 Women spend years dismissing their own symptoms due to lack of accessible, judgment-free health information
📱 Most period tracking apps focus purely on dates — not on the lived experience of hormonal health

Aarini changes that.

By combining real-time symptom logging, cycle intelligence, mood tracking, and the conversational power of Google Gemini AI, Aarini empowers women to:

Understand their hormonal patterns with clarity
Communicate confidently with healthcare providers
Build a rich, longitudinal health history
Receive personalized insights — not generic advice

Because every woman deserves a health companion that actually listens.

🚀 Key Features

🗓️ Period Tracking

Log and monitor your menstrual cycle dates with precision. Aarini learns your unique rhythm and helps you anticipate every phase — menstrual, follicular, ovulation, and luteal.

😊 Mood Tracking

Track emotional patterns day-by-day. Understand the hormonal roots of mood shifts and gain insights that help you plan, prepare, and practice self-compassion.

🩹 Symptom Logging

From cramps and bloating to headaches and fatigue — log any symptom with ease. Build a detailed health history that puts you in control during doctor's appointments.

🤖 AI Chat Assistant

Chat with Aarini's intelligent health assistant, powered by Google Gemini AI. Ask anything — from "Why do I feel so tired before my period?" to deeper hormonal health questions — and receive warm, accurate, empathetic responses.

</td>
<td width="50%">

💡 Wellness Insights

Receive personalized, AI-generated wellness insights based on your logged data. Aarini connects the dots between your cycle, mood, symptoms, and lifestyle — giving you actionable, compassionate guidance.

🔐 Firebase Authentication

Secure, seamless user authentication powered by Firebase. Your health data belongs to you — always protected, never shared.

☁️ Secure Cloud Storage

All your health data is encrypted and securely stored in Firebase Firestore — accessible only to you, across all your devices.

📊 Health Dashboard

A beautifully designed dashboard that visualizes your cycle history, mood trends, and symptom patterns at a glance — turning your data into a story you can understand.

</td>

🛠️ Tech Stack

Layer	Technology	Purpose
📱 Frontend	React Native + Expo	Cross-platform mobile application (iOS & Android)
⚙️ Backend	Flask (Python)	RESTful API server and business logic
🗄️ Database	Firebase Firestore	Real-time NoSQL cloud database
🔐 Authentication	Firebase Authentication	Secure user identity management
🤖 AI	Google Gemini API	Conversational AI health assistant & insights
🚀 Deployment	Render	Cloud backend hosting and deployment

🏗️ Architecture

┌─────────────────────────────────────────────────────────┐
│                                                         │
│   📱  MOBILE APPLICATION  (React Native + Expo)         │
│        iOS  ●  Android  ●  Cross-Platform               │
│                                                         │
└──────────────────────┬──────────────────────────────────┘
                       │  HTTPS / REST API
                       ▼
┌─────────────────────────────────────────────────────────┐
│                                                         │
│   ⚙️  FLASK API SERVER  (Python)                        │
│        Authentication  ●  Cycle Logic  ●  Insights      │
│        Deployed on Render                               │
│                                                         │
└───────────────┬───────────────────────┬─────────────────┘
                │                       │
                ▼                       ▼
┌───────────────────────┐   ┌───────────────────────────┐
│                       │   │                           │
│  🔥 FIREBASE          │   │  🤖 GOOGLE GEMINI AI      │
│     Firestore DB      │   │     Conversational AI     │
│     Authentication    │   │     Wellness Insights     │
│     Cloud Storage     │   │     Health Assistant      │
│                       │   │                           │
└───────────────────────┘   └───────────────────────────┘

Data Flow:

User Action → React Native App
           → Flask REST API (authentication + validation)
           → Firebase Firestore (data persistence)
           → Gemini AI (intelligent response generation)
           → Response back to App → Beautiful UI

📁 Project Structure

Aarini/
│
├── 📱 frontend/                    # React Native + Expo Application
│   ├── app/                        # Main application screens
│   │   ├── (auth)/                 # Authentication screens
│   │   │   ├── login.jsx
│   │   │   └── signup.jsx
│   │   ├── (tabs)/                 # Main tab navigation
│   │   │   ├── dashboard.jsx       # Health Dashboard
│   │   │   ├── tracking.jsx        # Period & Cycle Tracking
│   │   │   ├── symptoms.jsx        # Symptom Logging
│   │   │   ├── mood.jsx            # Mood Tracker
│   │   │   ├── insights.jsx        # Wellness Insights
│   │   │   └── chat.jsx            # AI Health Assistant
│   │   └── _layout.jsx
│   ├── components/                 # Reusable UI components
│   ├── constants/                  # App-wide constants & theme
│   ├── hooks/                      # Custom React hooks
│   ├── services/                   # API & Firebase services
│   ├── assets/                     # Images, fonts, animations
│   ├── app.json                    # Expo configuration
│   └── package.json
│
├── ⚙️ backend/                     # Flask Python API Server
│   ├── app.py                      # Main Flask application
│   ├── routes/                     # API route handlers
│   │   ├── auth.py                 # Authentication routes
│   │   ├── cycles.py               # Cycle tracking routes
│   │   ├── symptoms.py             # Symptom logging routes
│   │   ├── mood.py                 # Mood tracking routes
│   │   ├── chat.py                 # AI chat routes
│   │   └── insights.py             # Wellness insights routes
│   ├── services/                   # Business logic & integrations
│   │   ├── firebase_service.py     # Firebase Admin SDK
│   │   └── gemini_service.py       # Gemini AI integration
│   ├── models/                     # Data models & schemas
│   ├── utils/                      # Helper utilities
│   ├── requirements.txt            # Python dependencies
│   └── .env.example                # Environment variable template
│
├── 📚 docs/                        # Documentation
│   ├── API.md                      # Full API documentation
│   ├── ARCHITECTURE.md             # System architecture details
│   └── SETUP.md                    # Detailed setup guide
│
├── 📸 screenshots/                 # App screenshots & demos
│   ├── dashboard.png
│   ├── tracking.png
│   ├── chat.png
│   └── insights.png
│
├── 📄 README.md                    # You are here ✨
├── ⚖️  LICENSE                     # MIT License
└── 🤝 CONTRIBUTING.md              # Contribution guidelines

⚙️ Installation Guide

Prerequisites

Ensure you have the following installed:

Node.js (v18 or higher)
Python (v3.9 or higher)
Expo CLI (npm install -g expo-cli)
Git
A Firebase project
A Google Gemini API Key

1️⃣ Clone the Repository

git clone https://github.com/Him-an-shi/Aarini.git
cd Aarini

2️⃣ Frontend Setup (React Native + Expo)

# Navigate to the frontend directory
cd frontend

# Install dependencies
npm install

# Start the Expo development server
npx expo start

Scan the QR code with the Expo Go app on your phone, or press i for iOS simulator / a for Android emulator.

3️⃣ Backend Setup (Flask)

# Navigate to the backend directory
cd backend

# Create a virtual environment
python -m venv venv

# Activate the virtual environment
# On Windows:
venv\Scripts\activate
# On macOS/Linux:
source venv/bin/activate

# Install dependencies
pip install -r requirements.txt

# Copy environment variables template
cp .env.example .env
# → Fill in your credentials in the .env file

# Run the Flask development server
flask run

The backend will start at http://localhost:5000

4️⃣ Firebase Setup

Go to the Firebase Console and create a new project named Aarini
Enable Firebase Authentication → Email/Password provider
Enable Cloud Firestore → Start in production mode
Navigate to Project Settings → Service Accounts
Click Generate new private key → Download the JSON file
Place the downloaded JSON file in your backend/ directory
Set the path in your .env as shown in the Environment Variables section

Firestore Security Rules:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    match /users/{userId}/{document=**} {
      allow read, write: if request.auth != null && request.auth.uid == userId;
    }
  }
}

5️⃣ Configure Frontend API URL

In frontend/services/api.js, update the base URL to point to your Flask backend:

// For local development
const BASE_URL = 'http://localhost:5000'

// For production (Render deployment)
const BASE_URL = 'https://your-app-name.onrender.com'

🔐 Environment Variables

Create a .env file inside the backend/ directory based on the .env.example template:

# ─────────────────────────────────────────
# 🤖 Google Gemini AI
# ─────────────────────────────────────────
GEMINI_API_KEY=your_gemini_api_key_here
# Example: AIzaSyD-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# ─────────────────────────────────────────
# 🔥 Firebase Configuration
# ─────────────────────────────────────────
FIREBASE_SERVICE_ACCOUNT_JSON=./firebase-service-account.json
# Example: ./aarini-firebase-adminsdk-xxxxx.json

# ─────────────────────────────────────────
# ⚙️ Flask Configuration
# ─────────────────────────────────────────
FLASK_ENV=development
# Options: development | production

FLASK_DEBUG=True
# Set to False in production

SECRET_KEY=your_super_secret_key_here
# Example: a3f9b2c1d8e7f6a5b4c3d2e1f0a9b8c7

⚠️ IMPORTANT: Never commit your .env file or Firebase service account JSON to version control. They are already listed in .gitignore.

📡 API Reference

Base URL: http://localhost:5000 (development) | https://your-app.onrender.com (production)

All protected endpoints require the header:

Authorization: Bearer <firebase_id_token>

🔐 Authentication

Method	Endpoint	Description	Auth Required
`POST`	`/signup`	Register a new user account	❌
`POST`	`/login`	Authenticate user and get token	❌

POST /signup

// Request Body
{
  "email": "aarini@example.com",
  "password": "securepassword123",
  "name": "Priya Sharma"
}

// Response 201
{
  "message": "Account created successfully",
  "uid": "firebase_user_uid"
}

POST /login

// Request Body
{
  "email": "aarini@example.com",
  "password": "securepassword123"
}

// Response 200
{
  "token": "firebase_id_token",
  "uid": "firebase_user_uid",
  "name": "Priya Sharma"
}

🗓️ Cycle Tracking

Method	Endpoint	Description	Auth Required
`POST`	`/add-cycle`	Log a new menstrual cycle	✅
`GET`	`/cycles`	Retrieve full cycle history	✅

POST /add-cycle

// Request Body
{
  "start_date": "2025-06-01",
  "end_date": "2025-06-06",
  "flow_intensity": "moderate",
  "notes": "Mild cramping on day 1-2"
}

// Response 201
{
  "message": "Cycle logged successfully",
  "cycle_id": "cycle_doc_id"
}

GET /cycles

// Response 200
{
  "cycles": [
    {
      "cycle_id": "doc_id",
      "start_date": "2025-06-01",
      "end_date": "2025-06-06",
      "flow_intensity": "moderate",
      "cycle_length": 5,
      "notes": "Mild cramping on day 1-2"
    }
  ],
  "total": 1,
  "average_cycle_length": 28
}

🩹 Symptom Logging

Method	Endpoint	Description	Auth Required
`POST`	`/add-symptom`	Log a new symptom entry	✅
`GET`	`/symptoms`	Retrieve symptom history	✅

POST /add-symptom

// Request Body
{
  "date": "2025-06-01",
  "symptoms": ["cramps", "bloating", "fatigue"],
  "severity": "moderate",
  "notes": "Worst in the morning"
}

// Response 201
{
  "message": "Symptoms logged successfully",
  "symptom_id": "symptom_doc_id"
}

GET /symptoms

// Response 200
{
  "symptoms": [
    {
      "symptom_id": "doc_id",
      "date": "2025-06-01",
      "symptoms": ["cramps", "bloating", "fatigue"],
      "severity": "moderate",
      "notes": "Worst in the morning"
    }
  ],
  "total": 1
}

🤖 AI Chat Assistant

Method	Endpoint	Description	Auth Required
`POST`	`/chat`	Send message to AI health assistant	✅

POST /chat

// Request Body
{
  "message": "Why do I feel so tired before my period?",
  "context": {
    "cycle_phase": "luteal",
    "recent_symptoms": ["fatigue", "headache"]
  }
}

// Response 200
{
  "reply": "What you're experiencing is completely normal! During the luteal phase, progesterone levels rise significantly, which can cause fatigue...",
  "suggestions": [
    "Prioritize 8 hours of sleep",
    "Increase iron-rich foods",
    "Gentle movement like yoga"
  ]
}

💡 Wellness Insights

Method	Endpoint	Description	Auth Required
`GET`	`/insights`	Get personalized AI wellness insights	✅

GET /insights

// Response 200
{
  "insights": [
    {
      "category": "cycle_pattern",
      "title": "Your Cycle is Becoming More Regular",
      "description": "Based on your last 3 cycles, your average length is 28 days...",
      "actionable_tip": "Continue tracking to refine your predictions",
      "generated_at": "2025-06-10T17:29:00Z"
    }
  ]
}

🗺️ Roadmap

┌─────────────────────────────────────────────────────────────┐
│  PHASE 1 ✅  │  Foundation & Core Tracking                   │
│              │  ● User Authentication (Firebase)             │
│              │  ● Period Cycle Tracking                      │
│              │  ● Symptom Logging                            │
│              │  ● Mood Tracking                              │
│              │  ● Health Dashboard                           │
├─────────────────────────────────────────────────────────────┤
│  PHASE 2 🔄  │  Intelligence & Engagement                    │
│              │  ● AI Health Assistant (Gemini)               │
│              │  ● Personalized Wellness Insights             │
│              │  ● Push Notifications & Reminders             │
│              │  ● Cycle Prediction Engine                    │
├─────────────────────────────────────────────────────────────┤
│  PHASE 3 🔜  │  Analytics & Personalization                  │
│              │  ● Advanced Health Analytics                  │
│              │  ● Pattern Recognition & Trends               │
│              │  ● Hormone Phase Education                    │
│              │  ● Doctor Report Export (PDF)                 │
├─────────────────────────────────────────────────────────────┤
│  PHASE 4 🌟  │  Expansion & Integration                      │
│              │  ● Wearable Device Integration                │
│              │  ● PCOS Management Module                     │
│              │  ● Fertility Tracking                         │
│              │  ● Community & Support Groups                 │
│              │  ● Telehealth Integration                     │
└─────────────────────────────────────────────────────────────┘

🤝 Contributing

We believe the best healthcare tools are built by diverse, passionate communities. Aarini welcomes contributors from all backgrounds — whether you're a developer, designer, writer, or advocate for women's health.

How to Contribute

# 1. Fork the repository
# Click the "Fork" button on GitHub

# 2. Clone your fork
git clone https://github.com/YOUR_USERNAME/Aarini.git
cd Aarini

# 3. Create a feature branch
git checkout -b feature/your-amazing-feature

# 4. Make your changes and commit
git add .
git commit -m "✨ feat: add your amazing feature"

# 5. Push to your fork
git push origin feature/your-amazing-feature

# 6. Open a Pull Request on GitHub 🎉

Contribution Guidelines

Commit Type	Prefix	Example
New Feature	`✨ feat:`	`✨ feat: add ovulation prediction`
Bug Fix	`🐛 fix:`	`🐛 fix: cycle date validation`
Documentation	`📚 docs:`	`📚 docs: update API reference`
Styling	`💅 style:`	`💅 style: improve dashboard UI`
Refactoring	`♻️ refactor:`	`♻️ refactor: optimize Firebase queries`
Tests	`✅ test:`	`✅ test: add cycle tracking unit tests`

We're Looking For

Role	Contributions
📱 React Native Developers	UI components, new screens, animations, Expo features
🐍 Python Developers	Flask routes, AI integration, data processing
🔥 Firebase Developers	Firestore rules, auth flows, cloud functions
🎨 UI/UX Designers	Design systems, accessibility, user research
✍️ Technical Writers	Documentation, tutorials, API guides
💜 Women's Health Advocates	Feature ideas, user stories, real-world insights

🌍 Open Source

Aarini is proudly open source and committed to building a welcoming, inclusive community.

Getting Started

🟢 Beginner Friendly — Look for issues labeled good first issue to make your first contribution with confidence.

🔵 Help Wanted — Explore help wanted issues for impactful contributions.

🟣 Feature Requests — Have an idea? Open a feature request — we'd love to hear from you!

Community Values

🤝 Inclusive — Every voice matters. We welcome contributors of all experience levels.
🌸 Empathetic — We build with care for the women who will use this product.
🔒 Privacy-First — We handle health data with the highest standards of security and respect.
📖 Transparent — All decisions, roadmaps, and discussions happen in the open.

Ideal for

🎓 Students contributing to open-source programs (GSoC, GirlScript, Hacktoberfest, SSOC)
💼 Developers building their portfolio with meaningful, real-world projects
🌐 Contributors passionate about femtech, health tech, and social impact

🔮 Future Vision

Aarini is more than a period tracker. It is the beginning of a comprehensive women's wellness ecosystem.

We envision Aarini growing into a platform where:

🤝 Women and healthcare providers communicate through shared, structured health histories
🧬 AI evolves from reactive responses to proactive, predictive hormonal health coaching
⌚ Wearables contribute real-time biometric data for richer, more accurate insights
🌐 Communities form around shared conditions — PCOS, endometriosis, perimenopause — with peer support and professional guidance
🏥 Telehealth bridges the gap between daily tracking and medical consultation, making women's healthcare accessible globally
🌍 Multilingual support ensures Aarini reaches women regardless of geography or language

We believe that when women have access to accurate information, compassionate tools, and intelligent support, they make better health decisions — for themselves and for their families.

Aarini is that tool. And we're just getting started.

📄 License

MIT License

Copyright (c) 2025 Himanshi — Aarini Project

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

See the full LICENSE file for details.

💜 Closing Note

For every woman who was told her pain was "just cramps." For every woman who silently tracked her symptoms in a notes app, hoping someone would listen. For every woman who deserves a health companion as dedicated as she is.

Aarini was built for you.

Because understanding your body shouldn't require a medical degree. Because your hormonal health is valid, complex, and worthy of world-class technology. Because the future of women's wellness is intelligent, empathetic, and open.

Built with 💜 by Himanshi and the Aarini Community

"When women thrive, the world thrives."

⭐ If Aarini resonates with you, please give it a star — it means the world and helps more women discover it! ⭐

FilesExpand file tree

README.md

Latest commit

History

README.md

File metadata and controls

🌸 Aarini

Your AI-Powered Women's Hormonal Wellness & Period Health Companion

✨ About Aarini

💡 Why Aarini Exists

🚀 Key Features

🗓️ Period Tracking

😊 Mood Tracking

🩹 Symptom Logging

🤖 AI Chat Assistant

💡 Wellness Insights

🔐 Firebase Authentication

☁️ Secure Cloud Storage

📊 Health Dashboard

🛠️ Tech Stack

🏗️ Architecture

📁 Project Structure

⚙️ Installation Guide

Prerequisites

1️⃣ Clone the Repository

2️⃣ Frontend Setup (React Native + Expo)

3️⃣ Backend Setup (Flask)

4️⃣ Firebase Setup

5️⃣ Configure Frontend API URL

🔐 Environment Variables

📡 API Reference

🔐 Authentication

🗓️ Cycle Tracking

🩹 Symptom Logging

🤖 AI Chat Assistant

💡 Wellness Insights

🗺️ Roadmap

🤝 Contributing

How to Contribute

Contribution Guidelines

We're Looking For

🌍 Open Source

Getting Started

Community Values

Ideal for

🔮 Future Vision

📄 License

💜 Closing Note