"Know your body, Own your cycle" - A Web3-powered menstrual health companion that puts privacy and education first. https://bradyalimedi.wixsite.com/cyclebuddy-app

CycleBuddy revolutionizes menstrual health tracking by combining the privacy and security of Web3 with an intuitive, educational interface designed specifically for young users. We're not just building another period tracker – we're creating a movement to reshape how people learn about and interact with their bodies.

graph TD
    User((You)) --> A[Track Your Cycle]
    User --> B[Learn About Health]
    User --> C[Contribute to Research]
    
    A --> D[AI-Powered Insights]
    B --> E[Earn NFT Credentials]
    C --> F[Receive Compensation]
    
    D --> G[Private & Secure]
    E --> H[Knowledge Benefits]
    F --> I[Data Ownership]
    
    style User fill:#ff9999,stroke:#333,stroke-width:4px
    style A fill:#99ff99,stroke:#333,stroke-width:2px
    style B fill:#9999ff,stroke:#333,stroke-width:2px
    style C fill:#ffff99,stroke:#333,stroke-width:2px
    style D fill:#ff99ff,stroke:#333,stroke-width:2px
    style E fill:#99ffff,stroke:#333,stroke-width:2px
    style F fill:#ffcc99,stroke:#333,stroke-width:2px
    style G fill:#ccff99,stroke:#333,stroke-width:2px
    style H fill:#99ccff,stroke:#333,stroke-width:2px
    style I fill:#ffcc99,stroke:#333,stroke-width:2px

• Secure Authentication: Leveraging Stellar Passkeys for seamless and secure login
• Private Data Storage: Decentralized storage ensuring user data privacy
• Smart Tracking: AI-powered cycle predictions and insights
• Educational Hub: Age-appropriate, clear guidance
• Anonymous Community: Safe space for sharing and support
• Web3 Integration: Utilizing blockchain for data sovereignty

• Rapidly expanding niche: The global menstrual‑health‑apps market is valued at US $1.75 billion in 2024 and is projected to reach US $10.38 billion by 2034, a stunning 19.5 % CAGR (Precedence Research).

• Mass adoption, unmet needs: More than 50 million people already track their cycles with an app, yet woman say mainstream tools are too clinical, ad‑heavy, or privacy‑risky.

• Part of a booming FemTech wave: Women's‑health tech overall will top US $60 billion in 2025 and nearly double to ~US $130 billion by 2034, signalling strong investor interest and exit potential.

CycleBuddy's three breakthrough features that set it apart from any other health application:

flowchart LR
    subgraph "How It Works"
        direction TB
        Data([Your Health Data]) --> Encrypt([Encrypted Locally])
        Encrypt --> Process([Secure Processing])
        Process --> Insights([Personalized Insights])
        Insights --> You([Better Health Decisions])
    end
    
    style Data fill:#ffcccc,stroke:#333,stroke-width:2px
    style Encrypt fill:#ccffcc,stroke:#333,stroke-width:2px
    style Process fill:#ccccff,stroke:#333,stroke-width:2px
    style Insights fill:#ffffcc,stroke:#333,stroke-width:2px
    style You fill:#ffccff,stroke:#333,stroke-width:2px

• Advanced Pattern Detection: Identifies connections in your health data that are difficult to spot manually
• Personalized Health Intelligence: Tailored insights based on your unique patterns
• Early Warning System: Notices potential health concerns before they become serious
• Privacy-Preserving Analysis: All analysis happens on encrypted data - your private information stays private

flowchart LR
    subgraph "Knowledge Journey"
        direction TB
        Learn([Learn Health Topics]) --> Complete([Complete Modules])
        Complete --> Earn([Earn NFT Credentials])
        Earn --> Unlock([Unlock Benefits])
    end
    
    style Learn fill:#ffcccc,stroke:#333,stroke-width:2px
    style Complete fill:#ccffcc,stroke:#333,stroke-width:2px
    style Earn fill:#ccccff,stroke:#333,stroke-width:2px
    style Unlock fill:#ffffcc,stroke:#333,stroke-width:2px

• Learn-to-Earn Health Curriculum: Complete educational modules to earn unique NFT credentials
• Verifiable Health Knowledge: Your NFTs prove your health knowledge achievements
• Partner Benefits: Access special services from healthcare providers based on your credentials
• Community Engagement: Become a mentor to help others as you build your knowledge

flowchart LR
    subgraph "Research Contribution"
        direction TB
        Choose([Choose Research]) --> Share([Share Anonymous Data])
        Share --> Earn([Earn Compensation])
        Earn --> Impact([See Research Impact])
    end
    
    style Choose fill:#ffcccc,stroke:#333,stroke-width:2px
    style Share fill:#ccffcc,stroke:#333,stroke-width:2px
    style Earn fill:#ccccff,stroke:#333,stroke-width:2px
    style Impact fill:#ffffcc,stroke:#333,stroke-width:2px

• User-Controlled Data Sharing: You decide exactly what anonymous data to contribute
• Smart Contract Compensation: Automatic payment when your data meets quality criteria
• Reputation System: Earn higher compensation as you build a reliable contribution history
• Direct Research Impact: Track how your data helps important health research

graph TD
    You((You)) --> Track[Track Your Cycle]
    Track --> Insights[Get AI Insights]
    Insights --> Learn[Learn More]
    Learn --> Contribute[Contribute to Research]
    Contribute --> Better[Improve AI Models]
    Better --> Insights
    
    style You fill:#f9a,stroke:#333,stroke-width:4px
    style Track fill:#adf,stroke:#333,stroke-width:2px
    style Insights fill:#fda,stroke:#333,stroke-width:2px
    style Learn fill:#afd,stroke:#333,stroke-width:2px
    style Contribute fill:#dad,stroke:#333,stroke-width:2px
    style Better fill:#dfa,stroke:#333,stroke-width:2px

• Blockchain: Stellar Network
• Authentication: Stellar Passkeys Kit
• Frontend: React.js with Chakra UI
• Smart Contracts: Rust-based Stellar Smart Contracts
• Data Storage: Decentralized IPFS/Stellar combination

Detailed documentation can be found in the /docs directory:

• Architecture Overview
• Breakthrough Features Implementation
• User Flows
• Security Model
• Development Guide
• API Documentation
• Smart Contracts

flowchart TD
    Problem([Traditional Period Trackers]) --> A[Lack Privacy]
    Problem --> B[Overwhelming Interface]
    Problem --> C[Poor Education]
    Problem --> D[Complex Medical Forms]
    
    style Problem fill:#ffcccc,stroke:#333,stroke-width:3px
    style A fill:#ffdddd,stroke:#333,stroke-width:2px
    style B fill:#ffdddd,stroke:#333,stroke-width:2px
    style C fill:#ffdddd,stroke:#333,stroke-width:2px
    style D fill:#ffdddd,stroke:#333,stroke-width:2px

flowchart TD
    Solution([CycleBuddy Solution]) --> A[Web3 Privacy-First]
    Solution --> B[Intuitive Interface]
    Solution --> C[Educational Focus]
    Solution --> D[Supportive Community]
    
    style Solution fill:#ccffcc,stroke:#333,stroke-width:3px
    style A fill:#ddffdd,stroke:#333,stroke-width:2px
    style B fill:#ddffdd,stroke:#333,stroke-width:2px
    style C fill:#ddffdd,stroke:#333,stroke-width:2px
    style D fill:#ddffdd,stroke:#333,stroke-width:2px

• Node.js (v18+)
• npm or yarn
• Stellar CLI
• Freighter Wallet with funded testnet account

1. Clone this repository:

   git clone https://github.com/your-username/CycleBuddy-stellar.git
   cd CycleBuddy-stellar
   

2. Install dependencies:

   npm install
   

3. Run the setup script:

   ./scripts/setup-dev-env.sh
   

   This script will:

   • Check for required tools
   • Install Stellar CLI if needed
   • Set up the Stellar testnet

To deploy the contracts to the Stellar testnet:

1. Make sure you have Freighter Wallet installed

2. Fund your testnet account: Stellar Laboratory

3. Run the deployment script:

   ./scripts/deploy-contracts.sh
   

   This script will:

   • Deploy the Registry, Auth, Data, and Community contracts
   • Save the contract IDs to a .env file
   • Set up the contracts for use with the app

To run the application:

npm run dev

The app will be available at: http://localhost:3000

journey
    title User Journey with CycleBuddy
    section First Time
        Install App: 3: User
        Create Account: 4: User
        Setup Profile: 3: User
        Learn Interface: 4: User
    section Daily Use
        Track Cycle: 5: User
        View Insights: 5: User
        Complete Education: 4: User
    section Advanced Use
        Earn NFT Credentials: 5: User
        Contribute to Research: 4: User
        View Impact: 5: User

This project is licensed under the MIT License - see the LICENSE file for details.

We welcome contributions! Please see our Contributing Guide for details.

• Stellar Foundation for their amazing blockchain platform
• EasyA Consensus Hackathon for the opportunity
• Our early users and community for valuable feedback

• Email: bradyalimedi@gmail.com

This project uses a streamlined workflow for building and testing Stellar Soroban contracts. The main tools for contract management are:

1. Makefile - Contains all commands for building, testing, and deploying contracts
2. DeployContracts Component - Web UI for downloading contract files and providing deployment instructions

For a more user-friendly approach, you can use the DeployContracts page in the app:

1. Connect your Freighter wallet
2. Download each contract WASM file
3. Follow the on-screen instructions to upload and deploy each contract
4. Use the contract hash returned by each upload when deploying

This approach is useful when you need to deploy contracts from a different environment than your development machine.

Under the hood, these commands use the Makefile. To view the specific commands and options:

# View available make targets
make help

# Specify a custom Stellar address for deployment
make deploy STELLAR_ADDRESS=GBUKOFF6FX6767LKKOD3P7KAS43I3Z7CNUBPCH33YZKPPR53ZDHAHCER