<\/p>\n
Effective way to Learn:<\/strong><\/h5>\nTo fully benefit from this course, you need to do the following:<\/p>\n
\n- Bookmark this page<\/strong> as well as the page for the React UI.<\/li>\n
- Contribute<\/strong> to the main repo. Create a fork of the inventoryms repo. Clone this fork. And contribute changes, report issues, bugs, enhancements etc (How to contribute)<\/li>\n
- Check for daily updates<\/strong><\/li>\n
- Install necessary applications<\/strong> (IntelliJ, VsCode, MySQL Workbench, Postman Rest Client)<\/li>\n
- Actively participate<\/strong> in the discussions and periodic meetups<\/li>\n
- Reach out<\/strong> to Kindson or the community anytime you are stuck<\/li>\n<\/ul>\n
<\/p>\n
1. Introduction to InventoryMS<\/strong><\/h4>\nThis is the first part of our InventoryMS Complete application in React and Spring Boot. You will learn and implement the following concepts:<\/p>\n
\n- creating an REST API in SpringBoot<\/li>\n
- Implementing Spring Security<\/li>\n
- Implementing JPA Auditing<\/li>\n
- Creating Swagger Documentation<\/li>\n
- Implementing JWT Authentication<\/li>\n<\/ul>\n
Next steps (What you need to do)<\/strong><\/p>\n\n- Step 1<\/strong> – Fork the inventory-app<\/strong><\/em> repo on Github<\/li>\n
- Step 2<\/strong> – Fork the react-ui-app<\/em><\/strong> repo on Github<\/li>\n
- Step 3<\/strong> – Clone your fork of both repos to a local directory<\/li>\n
- Step 4<\/strong> – Update the Readme and create your first PR.<\/li>\n<\/ul>\n
If you would like to contribute to the project<\/p>\n
\n- let me know by mentioning it in the comment with #contribute<\/strong><\/em> hashtag<\/li>\n
- provide a brief bio in your first PR on the Readme.md<\/strong><\/em> file<\/li>\n
- you’ll be assigned a collaborator\/maintainer role on the repo<\/li>\n<\/ul>\n
<\/p>\n
2. Create the API Project with Spring Boot<\/strong><\/h4>\nIn this part we would setup the Spring Boot project on IntelliJ and add all the necessary dependencies.<\/p>\n
Add the necessary dependencies. The dependencies includes:<\/p>\n
\n- spring-boot-starter-security<\/li>\n
- mysql-connector-java<\/li>\n
- spring-boot-configuration-processor<\/li>\n
- spring-boot-starter-data-jpa<\/li>\n
- spring-boot-starter-web<\/li>\n
- lombok<\/li>\n
- spring-boot-starter-data-rest<\/li>\n<\/ul>\n
Any other dependency needed would be added as we progress.<\/p>\n
Add the MySQL properties in the application.properties<\/strong><\/em> file<\/p>\n <\/p>\n
3. Understand the InventoryMS Database Design<\/strong><\/h4>\nUnderstand the Inventory Data Model<\/p>\n
First, we need to obtain the .sql file for the inventory Database from here<\/a>. You don’t have to execute the statements since the tables would be generated by Hibernate from our Java files<\/p>\nHowever, take some time to look through the Database Design below and see how various tables relate.<\/p>\n![\"Inventory](\"https:\/\/www.kindsonthegenius.com\/wp-content\/uploads\/2024\/09\/Inventory-Database-Design.png\")
<\/a>Inventory Management System Database Design<\/figcaption><\/figure>\n <\/p>\n
4. Create the Data Models<\/strong><\/h4>\nNormally we could generate the Java classes from the database using an IntelliJ plugin called Reverse Engineering (previously JPA Buddy).<\/p>\n
However this plugin is available only in the Ultimate Edition of IntelliJ. This tutorial assumes you use IntelliJ Community Edition.<\/p>\n
So I will show you a way to generate the Java classes from Database that work both in Community and Ultimate editions of IntelliJ IDE. We would use the help of ChatGPT!<\/p>\n
However, you can find all the InventoryMS models here.<\/a><\/p>\nYou can add some initial data to the database.<\/p>\n
<\/p>\n
5. Create the Repository,\u00a0 Services and Controllers<\/strong><\/h4>\nThe Repositories<\/strong><\/p>\n\n- Create the repositories as interfaces that extends JpaRepository<\/em><\/strong>. You could create one of these, then copy across and refactor as needed.<\/li>\n
- Annotate the classes with the @Repository<\/em><\/strong> annotation.<\/li>\n
- Completed repository files<\/a><\/li>\n<\/ul>\n
The Services<\/strong><\/p>\n\n- You will need to create the services each annotated with the @Service<\/em><\/strong> annotation<\/li>\n
- Get the complete services here<\/li>\n
- Completed services files<\/a><\/li>\n<\/ul>\n
The REST Controllers<\/strong><\/p>\n\n- The REST controllers are annotated with the @RestController<\/strong><\/em> annotation<\/li>\n
- Get the complete controllers here<\/li>\n
- Completed controller files<\/a><\/li>\n<\/ul>\n
<\/p>\n
6. Enable Spring JPA Auditing<\/strong><\/h4>\nJPA Auditing allows you to automatically add the createdBy, lastUpdatedBy, creationDate, lastUpdatedDate. To enable Jpa Auditing, you can find the steps in the following links:<\/p>\n
\n- Jpa Auditing Video Tutorial<\/a><\/li>\n
- Step by Step tutorial<\/a><\/li>\n<\/ul>\n
For JPA Auditing and the next step, Spring Security, you will need to place all the files in the security package.<\/p>\n
You can obtain the files for the security package<\/a> from here.<\/p>\n <\/p>\n
7. Enable Spring Security with Basic Authentication<\/strong><\/h4>\nBasic authentication require username and password to be provided to access protected resources.<\/p>\n
\n- Follow the steps here to implement Spring Security<\/a><\/li>\n
- Spring Security video tutorial<\/a><\/li>\n<\/ul>\n
<\/p>\n
8. Enable Swagger API Documentation<\/strong><\/h4>\nSwagger allows you to generate OpenAPI specification for your SpringBoot API.<\/p>\n
For Spring Boot 3, just add this dependency below, and then visit the link:<\/p>\n
<dependency><\/span>\r\n <groupId><\/span>org.springdoc<\/groupId><\/span>\r\n <artifactId><\/span>springdoc-openapi-starter-webmvc-ui<\/artifactId><\/span>\r\n <version><\/span>2.0.2<\/version><\/span>\r\n<\/dependency><\/span>\r\n<\/pre>\nAfter adding the dependency, you can visit the link:<\/p>\n
http:\/\/localhost:8080\/swagger-ui\/index.html<\/a><\/p>\n
<\/p>\n
1. Introduction to InventoryMS<\/strong><\/h4>\nThis is the first part of our InventoryMS Complete application in React and Spring Boot. You will learn and implement the following concepts:<\/p>\n
\n- creating an REST API in SpringBoot<\/li>\n
- Implementing Spring Security<\/li>\n
- Implementing JPA Auditing<\/li>\n
- Creating Swagger Documentation<\/li>\n
- Implementing JWT Authentication<\/li>\n<\/ul>\n
Next steps (What you need to do)<\/strong><\/p>\n\n- Step 1<\/strong> – Fork the inventory-app<\/strong><\/em> repo on Github<\/li>\n
- Step 2<\/strong> – Fork the react-ui-app<\/em><\/strong> repo on Github<\/li>\n
- Step 3<\/strong> – Clone your fork of both repos to a local directory<\/li>\n
- Step 4<\/strong> – Update the Readme and create your first PR.<\/li>\n<\/ul>\n
If you would like to contribute to the project<\/p>\n
\n- let me know by mentioning it in the comment with #contribute<\/strong><\/em> hashtag<\/li>\n
- provide a brief bio in your first PR on the Readme.md<\/strong><\/em> file<\/li>\n
- you’ll be assigned a collaborator\/maintainer role on the repo<\/li>\n<\/ul>\n
<\/p>\n
2. Create the API Project with Spring Boot<\/strong><\/h4>\nIn this part we would setup the Spring Boot project on IntelliJ and add all the necessary dependencies.<\/p>\n
Add the necessary dependencies. The dependencies includes:<\/p>\n
\n- spring-boot-starter-security<\/li>\n
- mysql-connector-java<\/li>\n
- spring-boot-configuration-processor<\/li>\n
- spring-boot-starter-data-jpa<\/li>\n
- spring-boot-starter-web<\/li>\n
- lombok<\/li>\n
- spring-boot-starter-data-rest<\/li>\n<\/ul>\n
Any other dependency needed would be added as we progress.<\/p>\n
Add the MySQL properties in the application.properties<\/strong><\/em> file<\/p>\n <\/p>\n
3. Understand the InventoryMS Database Design<\/strong><\/h4>\nUnderstand the Inventory Data Model<\/p>\n
First, we need to obtain the .sql file for the inventory Database from here<\/a>. You don’t have to execute the statements since the tables would be generated by Hibernate from our Java files<\/p>\nHowever, take some time to look through the Database Design below and see how various tables relate.<\/p>\n<\/a>Inventory Management System Database Design<\/figcaption><\/figure>\n <\/p>\n
4. Create the Data Models<\/strong><\/h4>\nNormally we could generate the Java classes from the database using an IntelliJ plugin called Reverse Engineering (previously JPA Buddy).<\/p>\n
However this plugin is available only in the Ultimate Edition of IntelliJ. This tutorial assumes you use IntelliJ Community Edition.<\/p>\n
So I will show you a way to generate the Java classes from Database that work both in Community and Ultimate editions of IntelliJ IDE. We would use the help of ChatGPT!<\/p>\n
However, you can find all the InventoryMS models here.<\/a><\/p>\nYou can add some initial data to the database.<\/p>\n
<\/p>\n
5. Create the Repository,\u00a0 Services and Controllers<\/strong><\/h4>\nThe Repositories<\/strong><\/p>\n\n- Create the repositories as interfaces that extends JpaRepository<\/em><\/strong>. You could create one of these, then copy across and refactor as needed.<\/li>\n
- Annotate the classes with the @Repository<\/em><\/strong> annotation.<\/li>\n
- Completed repository files<\/a><\/li>\n<\/ul>\n
The Services<\/strong><\/p>\n\n- You will need to create the services each annotated with the @Service<\/em><\/strong> annotation<\/li>\n
- Get the complete services here<\/li>\n
- Completed services files<\/a><\/li>\n<\/ul>\n
The REST Controllers<\/strong><\/p>\n\n- The REST controllers are annotated with the @RestController<\/strong><\/em> annotation<\/li>\n
- Get the complete controllers here<\/li>\n
- Completed controller files<\/a><\/li>\n<\/ul>\n
<\/p>\n
6. Enable Spring JPA Auditing<\/strong><\/h4>\nJPA Auditing allows you to automatically add the createdBy, lastUpdatedBy, creationDate, lastUpdatedDate. To enable Jpa Auditing, you can find the steps in the following links:<\/p>\n
\n- Jpa Auditing Video Tutorial<\/a><\/li>\n
- Step by Step tutorial<\/a><\/li>\n<\/ul>\n
For JPA Auditing and the next step, Spring Security, you will need to place all the files in the security package.<\/p>\n
You can obtain the files for the security package<\/a> from here.<\/p>\n <\/p>\n
7. Enable Spring Security with Basic Authentication<\/strong><\/h4>\nBasic authentication require username and password to be provided to access protected resources.<\/p>\n
\n- Follow the steps here to implement Spring Security<\/a><\/li>\n
- Spring Security video tutorial<\/a><\/li>\n<\/ul>\n
<\/p>\n
8. Enable Swagger API Documentation<\/strong><\/h4>\nSwagger allows you to generate OpenAPI specification for your SpringBoot API.<\/p>\n
For Spring Boot 3, just add this dependency below, and then visit the link:<\/p>\n
<dependency><\/span>\r\n <groupId><\/span>org.springdoc<\/groupId><\/span>\r\n <artifactId><\/span>springdoc-openapi-starter-webmvc-ui<\/artifactId><\/span>\r\n <version><\/span>2.0.2<\/version><\/span>\r\n<\/dependency><\/span>\r\n<\/pre>\nAfter adding the dependency, you can visit the link:<\/p>\n
http:\/\/localhost:8080\/swagger-ui\/index.html<\/a><\/p>\n
Next steps (What you need to do)<\/strong><\/p>\n If you would like to contribute to the project<\/p>\n <\/p>\n In this part we would setup the Spring Boot project on IntelliJ and add all the necessary dependencies.<\/p>\n Add the necessary dependencies. The dependencies includes:<\/p>\n Any other dependency needed would be added as we progress.<\/p>\n Add the MySQL properties in the application.properties<\/strong><\/em> file<\/p>\n <\/p>\n Understand the Inventory Data Model<\/p>\n First, we need to obtain the .sql file for the inventory Database from here<\/a>. You don’t have to execute the statements since the tables would be generated by Hibernate from our Java files<\/p>\n However, take some time to look through the Database Design below and see how various tables relate.<\/p>\n <\/p>\n Normally we could generate the Java classes from the database using an IntelliJ plugin called Reverse Engineering (previously JPA Buddy).<\/p>\n However this plugin is available only in the Ultimate Edition of IntelliJ. This tutorial assumes you use IntelliJ Community Edition.<\/p>\n So I will show you a way to generate the Java classes from Database that work both in Community and Ultimate editions of IntelliJ IDE. We would use the help of ChatGPT!<\/p>\n However, you can find all the InventoryMS models here.<\/a><\/p>\n You can add some initial data to the database.<\/p>\n <\/p>\n The Repositories<\/strong><\/p>\n The Services<\/strong><\/p>\n The REST Controllers<\/strong><\/p>\n <\/p>\n JPA Auditing allows you to automatically add the createdBy, lastUpdatedBy, creationDate, lastUpdatedDate. To enable Jpa Auditing, you can find the steps in the following links:<\/p>\n For JPA Auditing and the next step, Spring Security, you will need to place all the files in the security package.<\/p>\n You can obtain the files for the security package<\/a> from here.<\/p>\n <\/p>\n Basic authentication require username and password to be provided to access protected resources.<\/p>\n <\/p>\n Swagger allows you to generate OpenAPI specification for your SpringBoot API.<\/p>\n For Spring Boot 3, just add this dependency below, and then visit the link:<\/p>\n After adding the dependency, you can visit the link:<\/p>\n http:\/\/localhost:8080\/swagger-ui\/index.html<\/a><\/p>\n\n
\n
2. Create the API Project with Spring Boot<\/strong><\/h4>\n
\n
3. Understand the InventoryMS Database Design<\/strong><\/h4>\n
<\/a>4. Create the Data Models<\/strong><\/h4>\n
5. Create the Repository,\u00a0 Services and Controllers<\/strong><\/h4>\n
\n
\n
\n
6. Enable Spring JPA Auditing<\/strong><\/h4>\n
\n
7. Enable Spring Security with Basic Authentication<\/strong><\/h4>\n
\n
8. Enable Swagger API Documentation<\/strong><\/h4>\n
<dependency><\/span>\r\n <groupId><\/span>org.springdoc<\/groupId><\/span>\r\n <artifactId><\/span>springdoc-openapi-starter-webmvc-ui<\/artifactId><\/span>\r\n <version><\/span>2.0.2<\/version><\/span>\r\n<\/dependency><\/span>\r\n<\/pre>\n