This is the backend restful service for https://github.com/mherman22/frontend.
- Java 17
- Spring Boot
- Mysql
- Lombok
- Hibernate JPA
- Spring Security
- Others include docker, maven,
Make sure you have java installed on your machine.
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
.
Follow the steps at https://mherman22.hashnode.dev/have-java-installed-on-ubuntu-easy-steps-i-followed to achieve that.
Follow the steps at https://docs.oracle.com/javase/10/install/installation-jdk-and-jre-macos.htm
Make sure your IDE has Lombok configured in it, if not do the following;-
- For Eclipse, follow the steps at https://projectlombok.org/setup/eclipse.
- For Intellijea, follow the steps at https://projectlombok.org/setup/intellij.
- For Netbeans, follow the steps at https://projectlombok.org/setup/netbeans.
- For Spring Tool Suite, follow the steps at https://projectlombok.org/setup/eclipse.
- For Visual Studio Code, follow the steps at https://projectlombok.org/setup/vscode.
- For JBoss Developer Studio, follow the steps at https://projectlombok.org/setup/eclipse
- 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 .
andgit 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.
The documentation for the rest api can be found at https://github.com/mherman22/KTMInv-docs