Merge branch 'main' into Library2

Code_of_Conduct.md

@@ -0,0 +1,70 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Behavior that contributes to a positive environment for our community that every one follow, includes:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and it also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [your email address]. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+<b>1. Correction</b>
+
+Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+<b>2. Warning</b>
+
+Community Impact: A violation through a single incident or series of actions.
+Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+<b>3. Temporary Ban</b>
+
+Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
+Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+<b>4. Permanent Ban</b>
+
+Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+Consequence: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant, version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.

Contributing.md

@@ -0,0 +1,67 @@
+
+
+# Contributing to LibraryMan-API
+
+Thank you for considering contributing to LibraryMan! We welcome contributions from everyone. Before you get started, please review our contribution guidelines below.
+
+## Table of Contents
+- [Getting Started](#getting-started)
+- [Opening a Pull Request](#opening-a-pull-request)
+- [Contribution Guidelines](#contribution-guidelines)
+- [Commit Messages](#commit-messages)
+- [Creating Issues](#creating-issues)
+- [Giving Feedback](#giving-feedback)
+
+## Getting Started
+
+1. **Fork the repository** to your own GitHub account.
+2. **Clone the repository** to your local machine:
+   ```bash
+   git clone https://github.com/YOUR_USERNAME/LibraryMan-API.git
+   ```
+3. **Set up the project** by following the instructions in the `README.md` file.
+4. **Make the changes** you want to contribute to the project.
+5. **Test your code** before submitting the pull request.
+
+## Opening a Pull Request
+
+In brief:
+- Commit your changes and ensure your commit messages adhere to the guidelines.
+- Create a new branch for your changes:
+  ```bash
+  git checkout -b <branch_name>
+  ```
+- Open a pull request and wait for approval from the maintainer to merge your changes.
+
+## Contribution Guidelines
+
+- Contributions such as low-code improvements, new features, and bug fixes are highly appreciated.
+- Feel free to open issues regarding bugs, doubts, or setup problems.
+- Be polite and interactive with other contributors; maintain a respectful environment.
+- Always test your code before submitting a pull request.
+- Use clear and descriptive titles for your pull requests summarizing your changes.
+- If your pull request addresses an issue, include the issue number in the PR title.
+
+## Commit Messages
+
+- Use meaningful commit messages related to your changes. 
+- Prefix your commit messages with the following:
+  - `fix:` for bug fixes.
+  - `feat:` for new features.
+  - `docs:` for documentation updates.
+  - `chore:` for miscellaneous changes.
+
+## Creating Issues
+
+- Use a clear and descriptive title for your issue.
+- Provide references (links, file paths, screenshots) related to the issue.
+
+- When suggesting new features, describe them in detail, including where you envision them in the project.
+
+## Giving Feedback
+
+If you enjoy working with us, please give the project a ⭐ star! Your support means a lot and encourages further contributions. 
+
+Thank you for your interest in LibraryMan-API! We look forward to your contributions! ❤️
+
+

README.md

@@ -48,7 +48,7 @@ Feel free to explore and use these project. If you encounter any issues or have
 
 Contributions are always welcome! ✨
 
-See [`contributing.md`](https://github.com/ajaynegi45/Library-API/blob/main/contributing.md) for ways to get started.
+See [`contributing.md`](https://github.com/ajaynegi45/Library-API/blob/main/Contributing.md) for ways to get started.
 
 Please adhere to this project's [`code_of_conduct.md`](https://github.com/ajaynegi45/Library-API/blob/main/code_of_conduct.md).
 

src/main/resources/application-development.properties

@@ -1,8 +1,14 @@
-# MySQL Database Connection
+## Database Setup First
+
+## Create a Database and add database name where "Add_Your_Database_Name" is below
+## Make this file as it was earlier before commiting code
+
+# Change this connection string to this format: jdbc:mysql://{ip_address}:{port}/{database_name}
 spring.datasource.url=jdbc:mysql://localhost:3306/Add_Your_Database_Name
+
+## Add your Database Username and Password
 spring.datasource.username=Add_Your_UserName
 spring.datasource.password=Add_Your_Password
-spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
 
 # Hibernate Dialect for MySQL 8
 spring.jpa.database-platform=org.hibernate.dialect.MySQLDialect
@@ -15,20 +21,25 @@ spring.sql.init.mode=never
 # Format SQL
 spring.jpa.properties.hibernate.format_sql=true
 
-# Logging for Spring Security
-logging.level.org.springframework.security=TRACE
-
 # Error Handling
 server.error.include-binding-errors=always
 server.error.include-message=always
 server.error.include-stacktrace=never
 server.error.include-exception=true
 
+# Logging for Spring Security
+logging.level.org.springframework.security=TRACE
+
+
+
 # --- Mail Service Setup ---
+
+# I use docker mail service https://hub.docker.com/r/maildev/maildev
+# Or Web based Mail service https://mailtrap.io/
 spring.mail.host=Add_Your_Mail_Service_Host
 spring.mail.port=Add_Your_Mail_Service_Port
 spring.mail.username=Add_Your_Mail_Service_Username
 spring.mail.password=Add_Your_Mail_Service_Password
 spring.mail.properties.mail.smtp.auth=Add_Your_Mail_Service_SMTP
-spring.mail.properties.mail.smtp.starttls.enable=Add_Your_Mail_Service_Start_TLS
-spring.mail.properties.domain_name=Add_Your_Mail_Service_Domain_Name
+spring.mail.properties.mail.starttls.enable=Add_Your_Mail_Service_Start_TLS
+spring.mail.properties.domain_name=Add_Your_Mail_Service_Domain_Name