diff --git a/README.md b/README.md index ccd11e1..582ab7a 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ![](images/logo_images.png) -# Shopp App - Backend +# Shopp App - Backend + Backend system provides restful API for web or mobile. [![CircleCI](https://circleci.com/gh/piomin/sample-spring-microservices-new.svg?style=svg)](https://app.circleci.com/pipelines/circleci/WpJpWzbAX4Dvhh2AjRnJmX/X6V4xLymFHgq4YEPN1Aiia) @@ -10,7 +11,8 @@ Backend system provides restful API for web or mobile. [![Coverage](https://sonarcloud.io/api/project_badges/measure?project=hoangtien2k3_shopapp-backend&metric=coverage)](https://sonarcloud.io/project/overview?id=hoangtien2k3_shopapp-backend) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=hoangtien2k3_shopapp-backend&metric=ncloc)](https://sonarcloud.io/project/overview?id=hoangtien2k3_shopapp-backend) -In this project I'm demonstrating you the most interesting features of [Spring Cloud Project](https://spring.io/projects/spring-cloud) for building microservice-based architecture. +In this project I'm demonstrating you the most interesting features +of [Spring Cloud Project](https://spring.io/projects/spring-cloud) for building microservice-based architecture. ## Introduction 💗💎❤️ @@ -31,8 +33,8 @@ handle the server-side logic and data processing for my application. - Restfull API - PostMan Testing API and Client. - Send message and receiver using Kafka server, Zookeeper, Broker. -- Redis cache database -- Flyway migration database version +- Redis cache database +- Flyway migration database version ## ✅Features @@ -59,32 +61,32 @@ Follow these steps to set up and run the backend: ```bash # Using Maven mvn clean install - - # Using Gradle - gradle build ``` #### 3. Configure the database: - Update `application.yml` with your mysql database connection details. -#### 4. Run the application: +#### 4. Run Docker (docker-compose) ```bash - # Using Maven - mvn spring-boot:run + cd shopapp-backend + + #run docker-compose + docker-compose up -d ``` -## Technologies Used +#### 5. Create [DATABASE](https://github.com/hoangtien2k3/shopapp-backend/blob/master/src/main/resources/database.sql) `shopapp` and add data demo: [DATA-DEMO](https://github.com/hoangtien2k3/shopapp-backend/blob/master/src/main/resources/data_demo.sql) in database Docker -- `Java`: The primary programming language. -- `Spring Boot`: Framework for building Java-based enterprise applications. -- `Maven/Gradle`: Build tools for managing dependencies and building the project. -- `Database`: Choose and specify the database system used (e.g., MySQL8). -- `Other Dependencies`: List any additional dependencies or libraries used. -- `Cache`: Using redis cache db +#### 6. Run the application: + +```bash + # Using Maven + mvn spring-boot:run +``` ## Databaes Mysql8 + ![mysql-8](images/database_diagram.jpg) ## Swagger-ui @@ -93,6 +95,20 @@ Follow these steps to set up and run the backend: ![swagger-ui](images/swagger-ui.jpg) +## PostMan Client + +![postman-project](images/postman_project.jpg) + + +## Technologies Used + +- `Java`: The primary programming language. +- `Spring Boot`: Framework for building Java-based enterprise applications. +- `Maven/Gradle`: Build tools for managing dependencies and building the project. +- `Database`: Choose and specify the database system used (e.g., MySQL8). +- `Other Dependencies`: List any additional dependencies or libraries used. +- `Cache`: Using redis cache db + ## API Documentation Document the API endpoints and their functionalities. You can use tools like `Swagger` for diff --git a/images/postman_project.jpg b/images/postman_project.jpg new file mode 100644 index 0000000..ded1374 Binary files /dev/null and b/images/postman_project.jpg differ