Merging Master to Develop

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+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]
+
+**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.

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+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.

.github/dependabot.yml

@@ -0,0 +1,7 @@
+version: 2
+updates:
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 10

.pre-commit-config.yaml

@@ -1,10 +1,10 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 default_language_version:
-    python: python3.10
+    python: python3.12
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
     -   id: check-added-large-files
     -   id: check-toml
@@ -14,19 +14,19 @@ repos:
     -   id: end-of-file-fixer
     -   id: trailing-whitespace
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v3.7.0
+    rev: v3.17.0
     hooks:
     -   id: pyupgrade
         args:
         - --py3-plus
         - --keep-runtime-typing
 -   repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: v0.0.275
+    rev: v0.5.6
     hooks:
     -   id: ruff
         args:
         - --fix
 -   repo: https://github.com/psf/black
-    rev: 23.3.0
+    rev: 24.8.0
     hooks:
     -   id: black

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Changelog for RidingMotoBackend 🎈
+# Changelog for Project Name 🎈
 
 All notable changes to this project will be documented in this file.
 

CONTRIBUTING.md

@@ -0,0 +1,41 @@
+# Contributing to <Project Name>
+
+First off, thank you for considering contributing to <Project Name>! 🙌 It's people like you that make <Project Name> such a great project.
+
+Here are some ways you can contribute:
+
+- [Contributing to <Project Name>](#contributing-to-<Project Name>)
+  - [Getting Started](#getting-started)
+  - [Reporting Bugs](#reporting-bugs)
+  - [Suggesting Enhancements](#suggesting-enhancements)
+  - [Code Contribution](#code-contribution)
+
+## Getting Started
+
+<Project Name> is using JIRA for issue tracking. Visit [our JIRA](JIRA URL) to find existing issues or create a new one.
+
+Our [Confluence](https://shiftboolean..com) is used for project documentation.
+
+For internal communication, we're using Slack.
+
+## Reporting Bugs
+
+We're using JIRA for bug tracking. Before reporting a bug, please check our JIRA to see if the bug has already been reported. If it hasn't, please create a new issue.
+
+## Suggesting Enhancements
+
+We welcome any ideas for making <Project Name> better! Feel free to create new issues in our JIRA for any feature requests or enhancements you think of.
+
+## Code Contribution
+
+Before contributing code, please check our GitHub repo [here](https://github.com/shiftboolean) to see if there is any ongoing work related to your intended contribution.
+
+Here are the steps for contributing code:
+
+1. Fork the repository and create your branch from `master`.
+2. Make sure your code lints and passes all tests.
+3. Issue a pull request.
+
+Your pull request will be reviewed and merged if it passes the review.
+
+We thank you for your contribution and making <Project Name> a better project!

LICENSE

@@ -1,11 +1,21 @@
-Internal Use License
+MIT License
 
-Copyright 2023 Shift Boolean
+Copyright (c) 2023 Shift Boolean
 
-Permission is hereby granted, free of charge, to current employees of Shift Boolean obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software within the confines of their employment with Shift Boolean, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit other employees to whom the Software is furnished to do so, subject to the following conditions:
+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:
 
-1. The software may only be used in the course of the employee's work for Shift Boolean.
-2. The software may not be shared with non-employees of Shift Boolean, either during or after the term of employment.
-3. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+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.
+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.

README.md

@@ -5,6 +5,16 @@
 ![Test Cases](https://img.shields.io/badge/Tests-100%25-brightgreen?style=for-the-badge)
 [![TeamCity](https://img.shields.io/teamcity/https/teamcity.url.com/e/badge.svg?style=for-the-badge&logo=teamcity)](https://teamcity.url.com/viewType.html?buildTypeId=<project_id>)
 
+## Todo
+
+- [ ] Update Project Name in README.md
+- [ ] Update Project Name in CONTRIBUTING.md
+- [ ] Update Project Name in CHANGELOG.md
+- [ ] Update Project Name in VERSION.md
+- [ ] Change MIT License to Internal Use License (IUL) and update in README.md
+- [ ] Update Readme Badge URL
+- [ ] Delete the Todo section
+
 ## Introduction 📚
 
 This project is the back-end API for the <Project Name> application. It's built with FastAPI and follows a modular monolith architecture. The application handles functionalities such as User Management, Social Media, Shop.
@@ -127,12 +137,8 @@ _Update Release version in query parameters_
 )
 
 ## License 📄
-
-This project is licensed under the [IUL License](LICENSE).
-Copyright (c) ShiftBoolean.
+This project is licensed under the [MIT License](LICENSE).
 
 ## Website 🌐
 
 Visit us at [ShiftBoolean](www.shiftboolean.com)
-
-

Versions.md

@@ -1,4 +1,4 @@
-# Versioning System for RidingMoto Backend 🎈
+# Versioning System for Project Name Backend 🎈
 
 In this project, we follow the Semantic Versioning system. This means that our version numbers follow the format of MAJOR.MINOR.PATCH. Here's what each component means:
 

requirements.txt

@@ -1,11 +1,11 @@
 fastapi>=0.99.1
 uvicorn>=0.22.0
-motor==3.2.0
-mypy==1.4.1
-ruff==0.0.277
-black == 23.3.0
-types-PyYAML==6.0.12.10
-types-ujson==5.8.0.0
-pydantic~=1.10.11
-pytest~=7.4.0
-httpx~=0.24.1
+motor==3.4.0
+mypy==1.10.0
+ruff==0.4.5
+black == 24.4.2
+types-PyYAML==6.0.12.20240311
+types-ujson==5.10.0.20240515
+pydantic~=2.7.1
+pytest~=8.2.1
+httpx~=0.27.0