Skip to content

Commit 25f6b06

Browse files
committed
add: sonarcloud
1 parent 55cacb8 commit 25f6b06

File tree

1 file changed

+24
-5
lines changed

1 file changed

+24
-5
lines changed

README.md

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,18 @@
1-
21
# 🛍️ Ecommerce-Microservice
32

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+
49
## 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.
613

714
## Prerequisites
15+
816
Before you begin, ensure you have met the following requirements:
917

1018
- Java Development Kit `(JDK) 17` or higher installed.
@@ -19,22 +27,27 @@ Before you begin, ensure you have met the following requirements:
1927
- Send message and receiver using Kafka server, Zookeeper, Broker.
2028

2129
## Features
30+
2231
- ✅ Using `Microservices` as a high level architecture
2332

2433
## Getting Started
34+
2535
Follow these steps to set up and run the backend:
2636

2737
1. Clone the repository:
38+
2839
```bash
2940
git clone https://github.com/hoangtien2k3/ecommerce-microservices.git
3041
```
3142

3243
#### 1. Navigate to the project directory:
44+
3345
```bash
3446
cd project-name-backend
3547
```
3648

3749
#### 2. Build the project:
50+
3851
```bash
3952
# Using Maven
4053
mvn clean install
@@ -44,10 +57,11 @@ Follow these steps to set up and run the backend:
4457
```
4558

4659
#### 3. Configure the database:
47-
- Update `application.properties` or `application.yml` with your database connection details.
4860

61+
- Update `application.properties` or `application.yml` with your database connection details.
4962

5063
#### 4. Run the application:
64+
5165
```bash
5266
# Using Maven
5367
mvn spring-boot:run
@@ -57,19 +71,24 @@ Follow these steps to set up and run the backend:
5771
```
5872

5973
## Technologies Used
74+
6075
- `Java`: The primary programming language.
6176
- `Spring Boot`: Framework for building Java-based enterprise applications.
6277
- `Maven/Gradle`: Build tools for managing dependencies and building the project.
6378
- `Database`: Choose and specify the database system used (e.g., MySQL, PostgreSQL).
6479
- `Other Dependencies`: List any additional dependencies or libraries used.
6580

6681
## 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`.
6885

6986
## Contributing
87+
7088
If you would like to contribute to the development of this project, please follow our contribution guidelines.
7189

7290
## License
91+
7392
This project is licensed under the [`MIT License`](LICENSE).
7493

7594
```text
@@ -87,7 +106,7 @@ Copyright (c) 2024 Hoàng Anh Tiến
87106
<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>
88107
<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>
89108
</tr>
90-
109+
91110
</table>
92111

93112
<!-- markdownlint-restore -->

0 commit comments

Comments
 (0)