Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mherman22/ktminv

Backend for https://github.com/mherman22/KTMInv-frontend
https://github.com/mherman22/ktminv

java jpa-hibernate mysql-database springboot

Last synced: 30 days ago
JSON representation

Backend for https://github.com/mherman22/KTMInv-frontend

Awesome Lists containing this project

README

        

# KTMInv [![CodeQL](https://github.com/mherman22/KTMInv/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/mherman22/KTMInv/actions/workflows/codeql-analysis.yml)

This is the backend restful service for .

## Tools used in development

[![Dependency Review](https://github.com/mherman22/KTMInv/actions/workflows/dependency-review.yml/badge.svg)](https://github.com/mherman22/KTMInv/actions/workflows/dependency-review.yml)

- Java 17
- [Spring Boot](https://spring.io/projects/spring-boot)
- Mysql
- [Lombok](https://projectlombok.org/)
- [Hibernate JPA](https://www.microsoft.com/software-download/windows10)
- [Spring Security](https://spring.io/projects/spring-security)
- Others include [docker](https://www.docker.com/), [maven](https://maven.apache.org/),

## How to Open the repo in an IDE?

Make sure you have [java](https://www.oracle.com/java/) installed on your machine.

### For Windows

For Windows platform/machine, do the following;-

- Download and install java 17.
- Set environment variable path (JAVA_HOME).
- Test to see if java has been installed. `java -version`.

### For Linux Platform

Follow the steps at to achieve that.

### For Mac

Follow the steps at

## How to Install Lombok in your IDE

Make sure your IDE has Lombok configured in it, if not do the following;-

- For Eclipse, follow the steps at .
- For Intellijea, follow the steps at .
- For Netbeans, follow the steps at .
- For Spring Tool Suite, follow the steps at .
- For Visual Studio Code, follow the steps at .
- For JBoss Developer Studio, follow the steps at

## Pull Requests? Wanna implement or make an addition or correct something?

- fork this repository.
- clone it onto your machine by running `git clone https://github.com/mherman22/KTMInv.git`.
- make your changes and test them to ensure everything perfect.
- create a branch `git checkout -b branch-name`.
- commit your changes to your branch using `git add .` and `git commit -m "commit message"`.
- pull from origin to ensure your local repo is in sync with upstream. use `git pull origin branch-name`
- push your changes using `git push origin branch-name`.
- create a pull request and give it a proper description stating clearly the changes you have added.

## Test endpoints

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/3ae8d7d63faf8975acb4)

## Documentation

The documentation for the rest api can be found at

## Created By

- [mherman22](https://github.com/mherman22)