1
-
2
1
# 🛍️ Ecommerce-Microservice
3
2
3
+ Backend system provides restful API for web or mobile.
4
+
5
+ [ ![ CircleCI] ( https://circleci.com/gh/piomin/sample-spring-microservices-new.svg?style=svg )] ( https://sonarcloud.io/project/issues?resolved=false&id=hoangtien2k3_ecommerce-microservices )
6
+
7
+ [ ![ SonarCloud] ( https://sonarcloud.io/images/project_badges/sonarcloud-black.svg )] ( https://sonarcloud.io/project/configuration?id=hoangtien2k3_ecommerce-microservices )
8
+
4
9
## Introduction
5
- Welcome to the backend component of ` ecommerce-microservice ` . This Java/Kotlin backend is designed to handle the server-side logic and data processing for my application.
10
+
11
+ Welcome to the backend component of ` ecommerce-microservice ` . This Java/Kotlin backend is designed to handle the
12
+ server-side logic and data processing for my application.
6
13
7
14
## Prerequisites
15
+
8
16
Before you begin, ensure you have met the following requirements:
9
17
10
18
- Java Development Kit ` (JDK) 17 ` or higher installed.
@@ -19,22 +27,27 @@ Before you begin, ensure you have met the following requirements:
19
27
- Send message and receiver using Kafka server, Zookeeper, Broker.
20
28
21
29
## Features
30
+
22
31
- ✅ Using ` Microservices ` as a high level architecture
23
32
24
33
## Getting Started
34
+
25
35
Follow these steps to set up and run the backend:
26
36
27
37
1 . Clone the repository:
38
+
28
39
``` bash
29
40
git clone https://github.com/hoangtien2k3/ecommerce-microservices.git
30
41
```
31
42
32
43
#### 1. Navigate to the project directory:
44
+
33
45
``` bash
34
46
cd project-name-backend
35
47
```
36
48
37
49
#### 2. Build the project:
50
+
38
51
``` bash
39
52
# Using Maven
40
53
mvn clean install
@@ -44,10 +57,11 @@ Follow these steps to set up and run the backend:
44
57
```
45
58
46
59
#### 3. Configure the database:
47
- - Update ` application.properties ` or ` application.yml ` with your database connection details.
48
60
61
+ - Update ` application.properties ` or ` application.yml ` with your database connection details.
49
62
50
63
#### 4. Run the application:
64
+
51
65
``` bash
52
66
# Using Maven
53
67
mvn spring-boot:run
@@ -57,19 +71,24 @@ Follow these steps to set up and run the backend:
57
71
```
58
72
59
73
## Technologies Used
74
+
60
75
- ` Java ` : The primary programming language.
61
76
- ` Spring Boot ` : Framework for building Java-based enterprise applications.
62
77
- ` Maven/Gradle ` : Build tools for managing dependencies and building the project.
63
78
- ` Database ` : Choose and specify the database system used (e.g., MySQL, PostgreSQL).
64
79
- ` Other Dependencies ` : List any additional dependencies or libraries used.
65
80
66
81
## API Documentation
67
- Document the API endpoints and their functionalities. You can use tools like ` Swagger ` for automated ` API documentation ` .
82
+
83
+ Document the API endpoints and their functionalities. You can use tools like ` Swagger ` for
84
+ automated ` API documentation ` .
68
85
69
86
## Contributing
87
+
70
88
If you would like to contribute to the development of this project, please follow our contribution guidelines.
71
89
72
90
## License
91
+
73
92
This project is licensed under the [ ` MIT License ` ] ( LICENSE ) .
74
93
75
94
``` text
@@ -87,7 +106,7 @@ Copyright (c) 2024 Hoàng Anh Tiến
87
106
<td align="center"><a href="https://www.linkedin.com/in/hoangtien2k3/"><img src="https://avatars.githubusercontent.com/u/122768076?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hoàng Anh Tiến</b></sub></a><br /><a href="https://github.com/hoangtien2k3/news-app/commits?author=hoangtien2k3" title="Code">💻</a> <a href="#maintenance-hoangtien2k3" title="Maintenance">🚧</a> <a href="#ideas-hoangtien2k3" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-hoangtien2k3" title="Design">🎨</a> <a href="https://github.com/hoangtien2k3/news-app/issues?q=author%hoangtien2k3" title="Bug reports">🐛</a></td>
88
107
<td align="center"><a href="https://www.linkedin.com/in/chung-hoang-b58948174/"><img src="https://avatars.githubusercontent.com/u/52132635?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Hoàng Anh Chung</b></sub></a><br /><a href="https://github.com/hoangtien2k3/news-app/commits?author=hoangtien2k3" title="Code">🤔</a> <a href="#design-hoangtien2k3" title="Design">🎨</a> <a href="https://github.com/hoangtien2k3/news-app/issues?q=author%hoangtien2k3" title="Bug reports">🐛</a></td>
89
108
</tr >
90
-
109
+
91
110
</table >
92
111
93
112
<!-- markdownlint-restore -->
0 commit comments