mertbahardogan / stock-tracking-system

Stock Tracking System

A Stock Tracking System backend application implemented in Java 21 with Spring Boot 3.1.4.

This backend application is used for tracking products, creating products, etc. simple stock tracking system provides operations.

Table of Contents

1. How to Contribute
2. Requirements
3. Version Control Standards
4. Copyright

How to Contribute

For the contributor covenant to this project, please check the Code of Conduct file.

Credits

Please check the Contributors List to see who makes this open-source alive.

Requirements

For building and running the application belows are required;

• Spring Boot 3.1.4
• JDK 21
• Gradle 7.6 or above
• PostgreSQL
• Flyway Migration

Version Control Standards

Below version control standards should be followed within the project;

• The default branch is main branch.
• Feature enhancements or defect fixes should not be committed to the default branch, they should be coded in feature or bug branches.
• Issues should be created for each feature or fix in the [Stock Tracking System GitHub Repository Project][stock-tracking-system-github].
• Pull request (PR) should be created for each feature/bug branch to main branch.
• While creating a PR "[Feature]: ", "[Bug]: " or "[Doc]: " prefix should be used to identify the PR type.
• PRs should be linked with a valid issue in the [Stock Tracnking System GitHub Repository Project][stock-tracking-system-github].
• If validations are passed in the main branch, then a merge branch request is created with "merge branch" label & a linked PR to the main branch.

Copyright

GNU General Public License v3.0 Permissions of this strong copyleft license are conditioned on making available complete source code of licensed works and modifications, which include larger works using a licensed work, under the same license. Copyright and license notices must be preserved. Contributors provide an express grant of patent rights. Please check the LICENSE file for more details.