Project Documentation
This project, Period Cramp Soother, is designed to help users track their menstrual cycles and manage symptoms effectively.
Features
- Dashboard for quick insights on cycle status
- Period tracking with customizable reminders
- Device control for connected health devices
- AI chatbot for personalized advice and support
- Comprehensive documentation for user guidance
Getting Started
To get started with the Period Cramp Soother, follow these steps:
- Clone the repository:
git clone https://github.com/yourusername/period-cramp-soother.git - Install dependencies:
npm install - Run the application:
npm run dev
Contributing
We welcome contributions! Please read our contributing guidelines for more information.
License
This project is licensed under the MIT License. See the LICENSE file for details.
Technologies Used
This project utilizes the following technologies:
- Frontend: Built using Next.js, TypeScript, and CSS-in-JS styling.
- Backend: Utilizes a RESTful API built with Node.js and Prisma for data storage.
- Authentication: Implements user authentication and authorization using OAuth and JWT.