Merge pull request #65 from tynab/develop

260618

Author: Tynab

Dockerfile

@@ -1,14 +1,17 @@
+# Tom tat: Image phuc vu chay CRM Spring Boot bang Maven Wrapper trong container.
 FROM eclipse-temurin:17-jdk-focal
 
 WORKDIR /app
 
+# Copy Maven Wrapper va pom truoc de cache dependency layer.
 COPY .mvn/ .mvn
 COPY mvnw pom.xml ./
 
 RUN chmod +x mvnw
 
 RUN ./mvnw dependency:go-offline
 
+# Copy source sau khi cache dependency de build/run nhanh hon khi code thay doi.
 COPY src ./src
 
-CMD ["./mvnw", "spring-boot:run"]
+CMD ["./mvnw", "spring-boot:run"]

Jenkinsfile

@@ -1,12 +1,14 @@
 pipeline {
+    // Tom tat: Pipeline build image CRM, push Docker Hub, restart container va
+    // gui thong bao Telegram theo tung stage.
     agent any
 
     environment {
-        // Telegram configre
+        // Cau hinh Telegram lay tu Jenkins credentials.
         TOKEN = credentials('telegram_token')
         CHAT_ID = credentials('telegram_chatid')
 
-        // Telegram message
+        // Noi dung thong bao duoc tao tu commit hien tai.
         GIT_MESSAGE = sh(returnStdout: true, script: "git log -n 1 --format=%s ${GIT_COMMIT}").trim()
         GIT_AUTHOR = sh(returnStdout: true, script: "git log -n 1 --format=%ae ${GIT_COMMIT}").trim()
         GIT_COMMIT_SHORT = sh(returnStdout: true, script: "git rev-parse --short ${GIT_COMMIT}").trim()
@@ -26,6 +28,7 @@ pipeline {
     stages {
         stage('Build') {
             steps {
+                // Build Docker image tu source hien tai.
                 sh "curl --location --request POST 'https://api.telegram.org/bot${TOKEN}/sendMessage' --form text='${TEXT_PRE}' --form chat_id='${CHAT_ID}'"
                 sh "curl --location --request POST 'https://api.telegram.org/bot${TOKEN}/sendMessage' --form text='${TEXT_BUILD}' --form chat_id='${CHAT_ID}'"
                 sh 'docker build -t yamiannephilim/crm:latest .'
@@ -34,6 +37,7 @@ pipeline {
 
         stage('Push') {
             steps {
+                // Push image len Docker Hub voi credential da cau hinh trong Jenkins.
                 sh "curl --location --request POST 'https://api.telegram.org/bot${TOKEN}/sendMessage' --form text='${TEXT_PUSH}' --form chat_id='${CHAT_ID}'"
 
                 withDockerRegistry(credentialsId: 'docker_hub', url: 'https://index.docker.io/v1/') {
@@ -44,6 +48,7 @@ pipeline {
 
         stage('Clean') {
             steps {
+                // Dung va xoa container crm cu neu dang ton tai.
                 sh "curl --location --request POST 'https://api.telegram.org/bot${TOKEN}/sendMessage' --form text='${TEXT_CLEAN}' --form chat_id='${CHAT_ID}'"
 
                 script {
@@ -58,6 +63,7 @@ pipeline {
 
         stage('Run') {
             steps {
+                // Tao network neu can va chay container moi tu image latest.
                 sh "curl --location --request POST 'https://api.telegram.org/bot${TOKEN}/sendMessage' --form text='${TEXT_RUN}' --form chat_id='${CHAT_ID}'"
                 sh 'docker container stop crm || echo "this container does not exist"'
                 sh 'docker network create yan || echo "this network exist"'

Procfile

@@ -1 +1,2 @@
-web: java -jar target/crm_project-0.0.1-SNAPSHOT.war
+# Tom tat: Lenh chay WAR khi deploy len nen tang kieu Heroku.
+web: java -jar target/crm_project-0.0.1-SNAPSHOT.war

README.md

@@ -36,13 +36,6 @@
         - Xem thống kê công việc (cá nhân)
         - Quản lý tài khoản cá nhân
 
-## LINK DEMO
-<div align='center'>
-
-[Click vào đây để xem chi tiết](https://crm.yamiannephilim.com)
-
-</div>
-
 ## HÌNH ẢNH DEMO
 <p align='center'>
 <img src='pic/0.jpg'></img>

database/crm.sql

@@ -1,19 +1,22 @@
--- dispose db
+-- Tom tat: Script khoi tao database CRM gom role, user, du an, trang thai
+-- cong viec va du lieu mau de demo ung dung Spring Boot.
+
+-- Xoa database cu de script co the chay lai tu dau.
 
 DROP DATABASE IF EXISTS crm;
 
--- create db
+-- Tao database crm neu chua ton tai.
 
 CREATE DATABASE IF NOT EXISTS crm;
 
--- use db
+-- Chon database lam viec.
 
 USE crm;
 
--- fix default
+-- Dam bao AUTO_INCREMENT tang tung don vi trong moi lan seed.
 SET @@auto_increment_increment=1;
 
--- create table loai_thanh_vien
+-- Bang vai tro nguoi dung: Admin, Leader, Member.
 
 CREATE TABLE
     IF NOT EXISTS loai_thanh_vien (
@@ -23,7 +26,7 @@ CREATE TABLE
         PRIMARY KEY (id)
     );
 
--- create table nguoi_dung
+-- Bang tai khoan nguoi dung va khoa ngoai den vai tro.
 
 CREATE TABLE
     IF NOT EXISTS nguoi_dung (
@@ -39,7 +42,7 @@ CREATE TABLE
         FOREIGN KEY (id_loai_thanh_vien) REFERENCES loai_thanh_vien(id)
     );
 
--- create table du_an
+-- Bang du an, moi du an co nguoi tao/originator.
 
 CREATE TABLE
     IF NOT EXISTS du_an (
@@ -53,7 +56,7 @@ CREATE TABLE
         FOREIGN KEY (id_nguoi_tao) REFERENCES nguoi_dung(id)
     );
 
--- create table trang_thai_cong_viec
+-- Bang danh muc trang thai cong viec.
 
 CREATE TABLE
     IF NOT EXISTS trang_thai_cong_viec (
@@ -62,7 +65,7 @@ CREATE TABLE
         PRIMARY KEY (id)
     );
 
--- create table cong_viec
+-- Bang cong viec, lien ket user thuc hien, du an va trang thai.
 
 CREATE TABLE
     IF NOT EXISTS cong_viec (
@@ -80,13 +83,13 @@ CREATE TABLE
         FOREIGN KEY (id_trang_thai_cong_viec) REFERENCES trang_thai_cong_viec(id)
     );
 
--- add data to loai_thanh_vien
+-- Seed vai tro mac dinh.
 
 INSERT INTO
     loai_thanh_vien (ten, mo_ta)
 VALUES ('Admin', 'Quản trị viên'), ('Leader', 'Quản lý dự án'), ('Member', 'Thành viên');
 
--- add data to nguoi_dung
+-- Seed user mau; comment sau hash la mat khau plaintext dung cho demo local.
 
 INSERT INTO
     nguoi_dung (
@@ -163,7 +166,7 @@ VALUES (
         3
     );
 
--- add data to du_an
+-- Seed du an mau.
 
 INSERT INTO
     du_an (
@@ -193,13 +196,13 @@ VALUES (
         4
     );
 
--- add data to trang_thai_cong_viec
+-- Seed trang thai task mac dinh.
 
 INSERT INTO
     trang_thai_cong_viec (ten)
 VALUES ('Chưa bắt đầu'), ('Đang thực hiện'), ('Đã hoàn thành');
 
--- add data to cong_viec
+-- Seed cong viec mau.
 
 INSERT INTO
     cong_viec (

pom.xml

@@ -1,4 +1,8 @@
 <?xml version="1.0" encoding="UTF-8"?>
+<!--
+    Tom tat: Maven project cho CRM Spring Boot MVC dong goi WAR, dung Thymeleaf,
+    Spring Security, Spring Data JPA, MySQL, JWT va imgscalr.
+-->
 <project xmlns="http://maven.apache.org/POM/4.0.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
@@ -14,7 +18,7 @@
     <version>0.0.1-SNAPSHOT</version>
     <packaging>war</packaging>
     <name>crm_project</name>
-    <description>Demo project for Spring Boot</description>
+    <description>Spring Boot CRM web application with Thymeleaf, JPA, Security and JWT</description>
     <properties>
         <java.version>11</java.version>
     </properties>
@@ -194,4 +198,4 @@
         </plugins>
     </build>
 
-</project>
+</project>

src/main/java/com/yan/crm_project/CrmProjApplication.java

@@ -4,6 +4,9 @@
 import org.springframework.boot.autoconfigure.*;
 
 @SpringBootApplication
+/**
+ * Tom tat: Diem khoi dong Spring Boot cho ung dung CRM.
+ */
 public class CrmProjApplication {
     public static void main(String[] args) {
         SpringApplication.run(CrmProjApplication.class, args);

src/main/java/com/yan/crm_project/ServletInitializer.java

@@ -3,6 +3,10 @@
 import org.springframework.boot.builder.*;
 import org.springframework.boot.web.servlet.support.*;
 
+/**
+ * Tom tat: Cho phep dong goi ung dung thanh WAR va chay tren servlet container
+ * ben ngoai.
+ */
 public class ServletInitializer extends SpringBootServletInitializer {
     @Override
     protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {

src/main/java/com/yan/crm_project/common/Bean.java

@@ -6,14 +6,21 @@
 import org.springframework.security.web.savedrequest.*;
 
 @Configuration
+/**
+ * Tom tat: Khai bao cac bean ha tang dung chung cho bao mat va request cache.
+ */
 public class ApplicationConfig {
-    // Passord encode BCrypt
+    /**
+     * Ma hoa mat khau nguoi dung bang BCrypt truoc khi luu vao database.
+     */
     @Bean
     public PasswordEncoder passwordEncoder() {
         return new BCryptPasswordEncoder();
     }
 
-    // Request cache
+    /**
+     * Khong tao session moi chi de luu request truoc dang nhap.
+     */
     @Bean
     public HttpSessionRequestCache getHttpSessionRequestCache() {
         var httpSessionRequestCache = new HttpSessionRequestCache();