GitHub issue template

CONTRIBUTING.md

@@ -0,0 +1,44 @@
+
+---
+
+### 3. **Creating a GitHub Issue Template**
+
+Create an issue template to standardize how issues are reported and handled. 
+
+- **Step 1**: Create a folder named `.github/ISSUE_TEMPLATE` in the root of the project.
+
+- **Step 2**: Add a new file `bug_report.md` to this folder for bug reports:
+
+```markdown
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] Your issue title"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '...'
+3. Scroll down to '...'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

DOCUMENTATION.md

@@ -0,0 +1,32 @@
+# Serenity Guide Documentation
+
+## Overview
+Serenity Guide is an open-source project designed to help users find tranquility through guided exercises. This project incorporates various tools and resources for users to manage stress, maintain focus, and build mindfulness practices.
+
+### Features:
+- **Guided Meditation Sessions**: Offers a variety of meditations to reduce stress and promote mindfulness.
+- **Mood Tracker**: Allows users to log their mood throughout the day, with historical data to track progress.
+- **Breathing Exercises**: Interactive breathing exercises designed to calm the nervous system.
+
+## Code Explanation
+
+### Main Features and How They Are Implemented
+
+1. **Meditation Sessions**
+    - The `meditation.js` file handles the various guided meditations. It includes a timer, user progress, and audio playback functionality.
+    - The sessions are stored as JSON objects and dynamically rendered based on user selection.
+
+2. **Mood Tracker**
+    - The `moodTracker.js` script handles user input related to mood, stores it in local storage, and displays it on the dashboard.
+    - We use the `Chart.js` library to render a graph showing the mood data.
+
+3. **Breathing Exercises**
+    - The breathing exercises are handled using the `breathing.js` module. It implements a basic animation for the inhale and exhale process, guiding the user through visual cues.
+    - Timers and event listeners are used to start/stop the breathing session.
+
+## Getting Started
+1. **Installation**: Clone the repository and install the necessary packages via npm.
+   ```bash
+   git clone https://github.com/Amna-Hassan04/Serenity-Guide.git
+   cd Serenity-Guide
+   npm install

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Amna-Hassan04
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] - "
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Windows, macOS]
+ - Browser [e.g. Chrome, Firefox]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, Safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: false
+contact_links:
+  - name: "Bug Report"
+    url: "/Amna-Hassan04/Serenity-Guide/issues/new?assignees=&labels=bug&template=bug_report.md&title="
+    about: "Report a bug or issue with the project"
+  - name: "Feature Request"
+    url: "/Amna-Hassan04/Serenity-Guide/issues/new?assignees=&labels=enhancement&template=feature_request.md&title="
+    about: "Suggest a new feature or enhancement"

feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] Your feature title"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex: I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen. If possible, include examples or screenshots from other projects.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

feature_request1.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEATURE] - "
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.