Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
46 changes: 46 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Eclipse project files
.project
.classpath
.settings

# IntelliJ IDEA project files and directories
*.iml
*.ipr
*.iws
.idea/

# Build targets
**/target/*

# Mac-specific directory that no other operating system needs.
.DS_Store

# JVM crash logs
hs_err_pid*.log

dependency-reduced-pom.xml

*/.unison.*

# exclude docker-sync stuff
.docker-sync
*/.docker-sync

# exclude vscode files
.vscode/
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.factorypath

# Maven ignore
.flattened-pom.xml

# misc
*classes
*.class
.svn
logs/
lib/
backup/
26 changes: 26 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Contributing
---
If you have good comments or suggestions, welcome to create [Issues](https://github.com/Tencent/polaris-java/issues) or [Pull Requests](https://github.com/Tencent/polaris-java/pulls),contribute to the polaris open source community.TBase continues to recruit contributors, even if it is answering questions in the issue, or doing some simple bugfixes, it will be of great help to polaris-java.

[Tencent Open Source Incentive Program](https://opensource.tencent.com/contribution) Encourage developers to participate and contribute, and look forward to your joining.

## Issue
#### For contributors

Please ensure that the following conditions are met before submitting an issue:

* Must be a bug or new feature
* Have searched in the issue, and did not find a similar issue or solution
* When creating a new issue, please provide a detailed description, screenshot or short video to help us locate the problem

## Pull Request
We welcome everyone to contribute code to make our product more powerful. The code team will monitor all pull requests, and we will do the corresponding code inspection and testing. After the test passes, we will accept the PR, but will not immediately merge into the master branch.

Please confirm before completing a PR:

1. Fork your own branch from the master branch.
2. Please modify the corresponding documents and comments after modifying the code.
3. Please add License and Copyright declarations in the newly created file.
4. Ensure a consistent code style.
5. Do adequate testing.
6. Then, you can submit your code to the dev branch.
5 changes: 5 additions & 0 deletions Code-of-Conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# TBase Community Code of Conduct
TBase follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).


Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the PolarisMesh Code of Conduct Committee via email: PolarisMesh_Community@qq.com
892 changes: 892 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

60 changes: 60 additions & 0 deletions README-zh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
polaris-java
========================================
北极星polaris是一个支持多种开发语言、兼容主流开发框架的服务治理中心。polaris-java是北极星的Java语言嵌入式服务治理SDK

## 快速入门

### 包依赖

#### 大前提:依赖管理
在工程根目录的pom中的<dependencyManagement></dependencyManagement>添加如下配置,即可在项目中引用需要的polaris-java子模块依赖。
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-dependencies</artifactId>
<version>${version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
```
#### 使用全量功能
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-factory</artifactId>
</dependency>
```
#### 仅服务注册发现
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-discovery-factory</artifactId>
</dependency>
```
#### 仅使用熔断降级
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-circuitbreaker-factory</artifactId>
</dependency>
```
#### 仅使用服务限流
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-ratelimit-factory</artifactId>
</dependency>
```

### 功能使用

各组件功能以及接口使用方式可参考对外开源文档:[使用polaris-java](https://github.com/PolarisMesh/website/blob/main/docs/zh/doc/%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8/%E4%BD%BF%E7%94%A8polaris-java.md)

## License

The polaris-java is licensed under the BSD 3-Clause License. Copyright and license information can be found in the file [LICENSE](LICENSE)

61 changes: 60 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,60 @@
# polaris-java
polaris-java
========================================
Polaris is an operation centre that supports multiple programming languages, with high compatibility to different application framework. Polaris - java is Polaris's Java embedded operation SDK.

## Quick Start

### Package Dependencies

#### PreCondition: DependencyManagement
Add the below script into the root pom element <dependencyManagement></dependencyManagement>, after that you can refer all the polaris dependency freely.
```xml
<dependencyManagement>
<dependencies>
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-dependencies</artifactId>
<version>${version}</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
```
#### Use all functions
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-factory</artifactId>
</dependency>
```
#### Use discovery only
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-discovery-factory</artifactId>
</dependency>
```
#### Use circuitbreak and degrade only
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-circuitbreaker-factory</artifactId>
</dependency>
```
#### Use ratelimit
```xml
<dependency>
<groupId>com.tencent.nameservice</groupId>
<artifactId>polaris-ratelimit-factory</artifactId>
</dependency>
```

### User manual

You can find detail in:[using polaris-java](https://github.com/PolarisMesh/website/blob/main/docs/zh/doc/%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8/%E4%BD%BF%E7%94%A8polaris-java.md)

## License

The polaris-java is licensed under the BSD 3-Clause License. Copyright and license information can be found in the file [LICENSE](LICENSE)

Loading