From c780f9ce5a3aeaf79f80effed95a3181ff45e22f Mon Sep 17 00:00:00 2001 From: yennanliu Date: Tue, 7 Nov 2023 14:08:37 +0800 Subject: [PATCH] add pic, update readme --- springBootBlog/README.md | 24 +++++++++++------- springBootBlog/doc/pic/SpringBlog.svg | 1 + springWarehouse/README.md | 28 +++++++++++++-------- springWarehouse/doc/pic/SpringWareHouse.svg | 1 + 4 files changed, 34 insertions(+), 20 deletions(-) create mode 100644 springBootBlog/doc/pic/SpringBlog.svg create mode 100644 springWarehouse/doc/pic/SpringWareHouse.svg diff --git a/springBootBlog/README.md b/springBootBlog/README.md index 2e6913779..e55e15f7f 100644 --- a/springBootBlog/README.md +++ b/springBootBlog/README.md @@ -1,5 +1,16 @@ -# markdown-blog -> Build a blog via spring boot with markdown +# Spring Blog + +

+ +Build a blog system via spring boot. Functionality : CRUD, Login/Logout (Spring security, OAuth), Blog post, edit, Comment, New user register, edit, Blog search + + +## Technology + +- Java 11 (JDK 11) +- Mybatis, Data Jpa, lombok +- Spring security, OAuth +- Mysql ### Login: @@ -97,6 +108,7 @@ nohup java -jar target/mdblog-0.0.1-SNAPSHOT.jar & ## API + | API | Type | Purpose | Example cmd | Comment | |----------|------|---------------------------------|--------------------------------------------------------|--------------------------------| | `GET` | GET | all posts | http://localhost:8888/posts/all | home page | @@ -113,14 +125,8 @@ nohup java -jar target/mdblog-0.0.1-SNAPSHOT.jar & | `GET /` | GET |Swagger | http://localhost:8888/swagger-ui.html |Api page| -## Technology -- Java 11 (JDK 11) -- Mybatis, Data Jpa, lombok -- Spring security, OAuth -- Mysql - - ## TODO + - UI improvement - FE layout when access via mobile - Admin page diff --git a/springBootBlog/doc/pic/SpringBlog.svg b/springBootBlog/doc/pic/SpringBlog.svg new file mode 100644 index 000000000..21e1cd0ee --- /dev/null +++ b/springBootBlog/doc/pic/SpringBlog.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/springWarehouse/README.md b/springWarehouse/README.md index 9cd670223..526e45b94 100644 --- a/springWarehouse/README.md +++ b/springWarehouse/README.md @@ -1,12 +1,26 @@ # Spring Warehouse System +

+ Build a Warehouse admin system with Spring boot. -This system is for internal operation users. offers product, merchant, and order management. -Warehouse data are maintained, managed via this app +This system is for internal operation users. offers product, merchant, and order management. Warehouse data are maintained, managed via this app + +## Technology +- Java 8 +- Spring boot +- mybatispluss +- thymeleaf +- Mysql + +## Data Model + +
+Data Model -- Data Model

+
+ - Main functionality - Add, remove, modify on *product* (storage), type, merchant, order @@ -15,14 +29,6 @@ Warehouse data are maintained, managed via this app - Merchant : business (company) who owns product - Orders : a transaction, product from warehouse will be sent to client -## Tech - -- Java 8 -- Spring boot -- mybatispluss -- thymeleaf -- Mysql - ## Run (local) diff --git a/springWarehouse/doc/pic/SpringWareHouse.svg b/springWarehouse/doc/pic/SpringWareHouse.svg new file mode 100644 index 000000000..94d360e3a --- /dev/null +++ b/springWarehouse/doc/pic/SpringWareHouse.svg @@ -0,0 +1 @@ + \ No newline at end of file