HarmoniQ - AI-Driven Time Management Tool with Menstrual Cycle Integration for Health Concious Entrepreneurs

HarmoniQ is an innovative tool designed to help entrepreneurs, especially women, optimize their productivity by aligning their work schedule with their menstrual cycle. This AI-driven platform offers personalized task management based on hormonal phases and integrates with Google Calendar for seamless productivity optimization.
Report Bug · Open PR

📖 Description

HarmoniQ is a time management tool that integrates AI-driven task scheduling with menstrual cycle tracking, designed specifically for entrepreneurs. By leveraging hormonal phases, the platform provides personalized productivity insights and recommendations to optimize work routines for women entrepreneurs.

(back to top)

📦 Related Technologies

The following technologies and platforms are relevant to this project:

• PydanticIA for AI-based tool management
• n8n for workflow automation (As prototype)
• Google Calendar API for syncing tasks and appointments
• Supabase for authentication and database management
• Node.js for backend API and task automation

(back to top)

⏩ Quick Setup

To start using HarmoniQ, follow these steps:

Run with Docker

HarmoniQ is containerized with Docker for easy setup and execution. To run the project using Docker:

1. Clone the repository:

   git clone https://github.com/poltergeistz/harmoniq.git
   cd harmoniq

2. Build the Docker container:

   docker-compose build

3. Start the application:

   docker-compose up

4. Open the app: Visit http://localhost:3000 to interact with the app.

If you're using Docker on a different port, you may need to update the docker-compose.yml to map it to your preferred port.

(back to top)

🔬 Testing

To test HarmoniQ:

1. Complete the onboarding process and input your menstrual cycle data.
2. Verify that the AI provides personalized task recommendations based on your hormonal phase.
3. Ensure that Google Calendar integrates seamlessly and that cycle data is handled securely using the RAG database.

(back to top)

🛠 Useful Tools and Resources

• PydanticIA Documentation
• n8n Documentation
• Google Calendar API Documentation
• MongoDB Documentation
• React.js Documentation

(back to top)

🌟 Features

• Personalized Task Management: AI-driven task scheduling based on hormonal phases to optimize productivity.
• Cycle-Based Productivity Insights: Recommendations for light tasks or wellness tips during specific phases like the luteal phase.
• Privacy-Focused Data Handling: Anonymized menstrual cycle data through the RAG database to protect user privacy.
• Calendar Integration: Seamless integration with Google Calendar to synchronize tasks and appointments.

(back to top)

🛠 Development

To start development on HarmoniQ:

git clone https://github.com/poltergeistz/harmoniq.git
cd harmoniq
npm install

Run the app using:

npm start

For Docker, follow the instructions in the Run with Docker section above to build and run the containerized app.

(back to top)

📄 License

Distributed under the Fair Source License. See LICENSE for more information.

(back to top)

📧 Contact

David J. - https://github.com/poltergeistz

Project Link: https://github.com/poltergeistz/harmoniq

(back to top)

Contribute

We welcome contributions from the community to help improve HarmoniQ! Whether you want to report bugs, suggest new features, or submit code, your input is appreciated.

How to Contribute

1. Fork the Repository: Click on the "Fork" button at the top of this repository to create your own copy of HarmoniQ.
2. Clone the Repository: Clone your forked repository to your local machine using:

   git clone https://github.com/poltergeistz/harmoniq.git

3. Create a Branch: Make sure to create a new branch for each feature or bug fix you work on.

   git checkout -b feature/your-feature-name

4. Make Changes: Implement your changes and write tests if necessary.
5. Commit Changes: Commit your changes with a clear, descriptive message.

   git commit -m "Add new feature or fix"

6. Push Changes: Push your changes to your forked repository.

   git push origin feature/your-feature-name

7. Create a Pull Request: Open a pull request to the main repository, and make sure to describe your changes clearly.

Reporting Issues

If you encounter any issues, please open an issue with a detailed description of the problem, steps to reproduce it, and any relevant logs or error messages.

(back to top)