SheSync is a comprehensive women's health and wellness platform built with modern web technologies. The platform aims to provide a supportive environment for women to access health resources, connect with healthcare professionals, and engage with a community of like-minded individuals.
- AI-Powered Health Assistant: Get instant answers to your health-related questions
- Community Forum: Connect with other women and share experiences
- Educational Resources: Access curated health and wellness information
- Professional Consultation: Connect with healthcare providers
- Period Tracking: Monitor and understand your menstrual cycle
- Shop: Access health and wellness products
- React 18
- Vite
- TailwindCSS
- Framer Motion (for animations)
- React Router DOM
- Google Maps API
- Google Generative AI
- Clerk Authentication: Secure user authentication with Clerk
- Headless UI
- Radix UI
- React Icons
- Lucide React
- React Feather
- ESLint
- PostCSS
- Autoprefixer
- TypeScript support
- Clone the repository:
git clone https://github.com/yourusername/SheSync.git
cd SheSync- Install dependencies:
npm install- Create a
.envfile in the root directory and add necessary environment variables:
VITE_SERVER_URL=https://shesync.onrender.com/
VITE_GEMINI_API_KEY=AIzaSyDC_nwnZggf8CYID3qvJfazEE8KBnqd9Ro // Use new API key, this one is not working
VITE_CLERK_PUBLISHABLE_KEY=pk_test_YW11c2luZy1ob3JuZXQtOS5jbGVyay5hY2NvdW50cy5kZXYk
VITE_GOOGLE_MAPS_API_KEY=AIzaSyB5pTapWtBsb95f5qpxiadprABnynOIZdQ- Start the development server:
npm run dev- To use the Dockerfile, you need to have Docker installed on your machine. Follow these steps:
a. Build the Docker image by running the following command from the root directory of the project:
For Frontend:
docker build -t shesync-frontend .- to run Frontend:
docker run -it -p 5173:5173 shesync-frontendFor Backend (You have to be in Backend folder) :
docker build -t shesync-backend .- to run Backend:
docker run -it -p 3000:3000 shesync-backendTo build both the docker Images at once
docker-compose up --buildTo run both the docker Images at once
docker-compose upsrc/
├── components/ # Reusable UI components
│ ├── Landing.jsx # Main landing page component
│ ├── Dashboard.jsx # User dashboard interface
│ ├── ParentDashboard.jsx # Parent-specific dashboard
│ ├── PartnerDashboard.jsx # Partner-specific dashboard
│ ├── PeriodTracker.jsx # Period tracking functionality
│ ├── SymptomAnalysis.jsx # Health symptom analysis tool
│ ├── Chatbot.jsx # AI-powered health assistant
│ ├── CommunityChat.jsx # Community chat interface
│ ├── Forum.jsx # Community forum component
│ ├── Blogs.jsx # Health blog section
│ ├── Consultations.jsx # Healthcare consultation booking
│ ├── Ecom.jsx # E-commerce shop interface
│ ├── Login.jsx # User authentication
│ ├── Signup.jsx # User registration
│ ├── Quiz.jsx # Health assessment quiz
│ ├── PrivacyForm.jsx # Privacy policy form
│ └── ModernTeamShowcase.jsx # Team member showcase
│
├── utils/ # Utility functions and helpers
│ └── gemini.js # Google Gemini AI integration
│
├── styles/ # Global styles and CSS
│ └── index.css # Main stylesheet
│
├── App.jsx # Main application component
├── main.jsx # Application entry point
└── index.css # Global styles
public/ # Static assets
├── images/ # Image assets
└── icons/ # Icon assets
Backend/ # Backend server code
├── controllers/ # Route controllers
├── models/ # Database models
├── routes/ # API routes
└── config/ # Configuration files
- Landing Page: Main entry point with feature showcase and navigation
- Dashboard: Personalized user interface with health metrics and quick actions
- Period Tracker: Menstrual cycle tracking and analysis
- Symptom Analysis: AI-powered health symptom assessment
- Chatbot: AI health assistant powered by Google Gemini
- Forum: Community discussion platform
- Community Chat: Real-time chat functionality
- Blogs: Health and wellness articles
- ModernTeamShowcase: Healthcare professional profiles
- Login/Signup: User authentication and registration with Clerk authentication system
- PrivacyForm: Privacy policy and data handling
- Quiz: Initial health assessment
- Consultations: Healthcare provider booking system
- Ecom: Health and wellness product marketplace
- ParentDashboard: Features for parents/guardians
- PartnerDashboard: Features for partners/spouses
- React Components: Modular, reusable UI components
- State Management: React hooks and context
- Routing: React Router for navigation
- Styling: TailwindCSS for responsive design
- Animations: Framer Motion for smooth transitions
- API Integration: Axios for HTTP requests
- Authentication: Clerk middleware Authentication
- Database: MongoDB for data storage
- Real-time Features: WebSocket integration
- Build Tool: Vite for fast development
- Code Quality: ESLint for code linting
- Version Control: Git for source control
- Package Management: npm for dependencies
We welcome contributions from the community! Here's how you can help:
- Fork the repository
- Create a new branch (
git checkout -b feature/amazing-feature) - Make your changes
- Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
- Follow the existing code style
- Use meaningful variable and function names
- Add comments for complex logic
- Write unit tests for new features
- Ensure all tests pass before submitting a PR
We are committed to making participation in this project a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members
This project is licensed under the MIT License - see the LICENSE file for details.
- All contributors who have helped shape this project
- The open-source community for their invaluable tools and libraries
- Healthcare professionals who have provided guidance and expertise
If you need help or have questions, please:
- Open an issue in the GitHub repository
- Contact the maintainers
- Join our community forum