Skip to content

Latest commit

 

History

History
78 lines (48 loc) · 3.29 KB

README.md

File metadata and controls

78 lines (48 loc) · 3.29 KB
Raw

Okay to Bleed🩸

Welcome to Okay to Bleed, an interactive menstrual education website aimed at improving menstruation awareness.

Table of Contents

Introduction

okay to bleed

Okay to Bleed is a website designed to provide comprehensive menstrual education and raise awareness about menstruation-related topics. Our goal is to break the stigma surrounding menstruation and promote a positive and informed outlook on this natural bodily process. The website offers interactive modules, informative articles, and engaging resources to help users learn about menstruation in a supportive and inclusive environment.

Features

  • Interactive Modules: Okay to Bleed offers interactive modules that cover various aspects of menstruation, including menstrual cycle, hormonal changes, menstrual products, and menstrual hygiene. Users can engage with these modules to understand the menstrual process better.

  • Informative Articles: The website provides a collection of well-researched articles on topics such as menstrual health, period myths, managing menstrual discomfort, and sustainable menstruation. These articles aim to provide accurate information and debunk common misconceptions.

  • Q&A Forum: Okay to Bleed includes a community-driven Q&A forum where users can ask questions, share experiences, and seek advice related to menstruation. This feature promotes dialogue and enables users to learn from each other in a safe and supportive space.

  • Resource Library: The website hosts a resource library comprising downloadable guides, infographics, and recommended reading materials. These resources offer additional information and references for users to explore in their own time.

Installation

To run Okay to Bleed locally on your machine, please follow these steps:

  1. Clone the repository to your local machine using the following command:

    git clone https://github.com/your-username/okay-to-bleed.git

  2. Navigate to the project directory:

    cd okay-to-bleed

  3. Install the project dependencies:

    yarn install

  4. Start the development server:

    yarn dev

  5. Open your web browser and visit http://localhost:5173/ to access Okay to Bleed.

Usage

Okay to Bleed is designed to be intuitive and user-friendly. Upon accessing the website, users can navigate through the 4 sections, explore interactive modules, and read articles. Okay to Bleed provides multilingual services including English, Korea, Nepali, French and Vietnamese.

Contributing

We welcome contributions to enhance and expand Okay to Bleed(especially for translations😇). If you're interested in contributing, please follow these steps:

  1. Fork the repository on GitHub.

  2. Create a new branch with a descriptive name for your feature or bug fix.

  3. Make the necessary changes, add new features, add translation, or fix typo/bugs.

  4. Test your changes to ensure they work as intended.

  5. Commit your changes and push them to your forked repository.

  6. Open a pull request in the main