Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Amna-Hassan04 authored Sep 30, 2024
1 parent f938c44 commit a9c2f8d
Showing 1 changed file with 52 additions and 24 deletions.
76 changes: 52 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,52 +1,80 @@
# SereniFi
# SereniFi
Feel Calm, Centered, and Peaceful

## Prototype Video- https://www.youtube.com/watch?v=j4-efJYhnzs
[![Prototype Video](https://img.shields.io/badge/Watch-Prototype_Video-red)](https://www.youtube.com/watch?v=j4-efJYhnzs)

## 📜 Overview

SereniFi Guide is a comprehensive mind-relaxing application designed to help users achieve mental tranquility and enhance well-being. Through a combination of guided meditations, breathing exercises, and soothing music, Serenity Guide offers a serene experience tailored to individual needs. Perfect for those seeking to unwind, focus, or find inner peace amidst the daily grind.
## GitHub Repository Stats

## 🎯 Features
| 🌟 **Stars** | 🍴 **Forks** | 🐛 **Issues** | 🔔 **Open PRs** | 🔕 **Closed PRs** |
|--------------|--------------|---------------|-----------------|------------------|
| ![GitHub stars](https://img.shields.io/badge/stars-2-blue) | ![GitHub forks](https://img.shields.io/badge/forks-1-brightgreen) | ![GitHub issues](https://img.shields.io/badge/issues-0-red) | ![Open PRs](https://img.shields.io/badge/pull%20requests-0-yellow) | ![Closed PRs](https://img.shields.io/badge/pull%20requests-2-lightgrey) |

- **Guided Meditations 🧘‍♂️:** A variety of meditation practices ranging from quick 5-minute sessions to extended deep relaxation.
- **Breathing Exercises 🌬️:** Techniques for controlled breathing to help reduce stress and improve concentration.
- **Relaxation Music 🎶:** A selection of calming background music and nature sounds to create a peaceful atmosphere.
- **Daily Tips 🌱:** Mindfulness tips and inspirational quotes delivered daily to start your day on a positive note.
- **Progress Tracking 📊:** Tools to monitor your relaxation journey with insightful metrics and achievements.
## 🏆 Featured in

| Event Logo | Event Name | Event Description |
|------------|-------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| ![GSSoC 24](https://gssoc.girlscript.tech/GS_logo_Black.svg) | GirlScript Summer of Code 2024 Ext | GirlScript Summer of Code Ext Edition is a One-month-long Open Source Program conducted from 1st Octuber to 30th octuber by GirlScript Foundation. It is an initiative to bring more beginners to Open-Source Software Development. |


## Overview
📜 **SereniFi Guide** is a comprehensive mind-relaxing application designed to help users achieve mental tranquility and enhance well-being. Through guided meditations, breathing exercises, and soothing music, SereniFi offers a serene experience tailored to individual needs. Perfect for those seeking to unwind, focus, or find inner peace amidst the daily grind.

---

## 🌟 Features
- **Guided Meditations** 🧘‍♂️: Choose from quick 5-minute sessions to extended deep relaxation.
- **Breathing Exercises** 🌬️: Techniques to reduce stress and improve focus through controlled breathing.
- **Relaxation Music** 🎶: Calming background music and nature sounds to create a peaceful atmosphere.
- **Daily Tips** 🌱: Receive mindfulness tips and inspirational quotes every day to stay positive.
- **Progress Tracking** 📊: Monitor your relaxation journey with insightful metrics and achievements.

---

## 🛠️ Installation

To set up Serenity Guide on your local machine, follow these steps:
To set up SereniFi on your local machine, follow these steps:

1. **Clone the Repository:**
1. **Clone the Repository**
```bash
git clone https://github.com/your-username/serenity-guide.git
```
2. **Navigate to the Project Directory:**

2. **Navigate to the Project Directory**
```bash
cd serenity-guide
```
3. **Install Dependencies:**

3. **Install Dependencies**
```bash
npm install
```
4. **Start the Application:**

4. **Start the Application**
```bash
npm start
```

## 🧑‍🤝‍🧑 About the Team
---

---

## 🌟 Contributors

| ![Amna Hassan](https://avatars.githubusercontent.com/Amna-Hassan04?s=50) | ![Anushka Pote](https://avatars.githubusercontent.com/Anushka-Pote?s=50) | ![K. Madhuri](https://avatars.githubusercontent.com/pearll12?s=50) | ![Pearl V](https://avatars.githubusercontent.com/madhurik04?s=50) |
|:--:|:--:|:--:|:--:|
| [Amna Hassan](https://github.com/Amna-Hassan04) | [Anushka Pote](https://github.com/username2) | [K. Madhuri](https://github.com/username3) | [Pearl V](https://github.com/username4) |

---

Serenity Guide is developed by a dedicated team of professionals committed to promoting mental well-being. Our team includes:
## 🏆 Acknowledgments

- **Amna Hassan**
- **Anushka Pote**
- **K. Madhuri**
- **Pearl V**
A heartfelt thanks to all contributors, testers, and supporters. Special thanks to **OSS Codess Cafe Cohort 5** for their unwavering support and encouragement. This project was initially made as a hackathon submission and secured 3rd place in that hackathon.

Together, we strive to create a tool that makes relaxation and mindfulness accessible to everyone.
---

## 🌟 Acknowledgments
## Contribution Guidelines
We welcome contributions! Please read our [Code of Conduct] to participate in this project. By contributing, you agree to abide by its terms.

We extend our heartfelt thanks to all contributors, testers, and supporters who have played a crucial role in the development of SereniFi. Special thanks to OSS Codess Cafe Cohort for their unwavering support and encouragement.
## License
This project is licensed under the **GPL-3.0 License**

0 comments on commit a9c2f8d

Please sign in to comment.