README.md 4.8 KB
Newer Older
智布道's avatar
智布道 已提交
1
<p align="center">
智布道's avatar
智布道 已提交
2
	<a href="https://docs.justauth.whnb.wang"><img src="./_media/cover.png" width="400"></a>
智布道's avatar
智布道 已提交
3 4 5 6 7 8 9 10 11
</p>
<p align="center">
	<strong>Login, so easy!</strong>
</p>
<p align="center">
	<strong>史上最全的整合第三方登录的开源库</strong>
</p>
<p align="center">
	<a target="_blank" href="https://search.maven.org/search?q=JustAuth">
12
		<img src="https://img.shields.io/badge/Maven%20Central--1.15.1-blue" ></img>
智布道's avatar
智布道 已提交
13 14 15 16 17 18 19
	</a>
	<a target="_blank" href="https://gitee.com/yadong.zhang/JustAuth/blob/master/LICENSE">
		<img src="https://img.shields.io/apm/l/vim-mode.svg?color=yellow" ></img>
	</a>
	<a target="_blank" href="https://www.oracle.com/technetwork/java/javase/downloads/index.html">
		<img src="https://img.shields.io/badge/JDK-1.8+-green.svg" ></img>
	</a>
智布道's avatar
智布道 已提交
20
	<a target="_blank" href="https://apidoc.gitee.com/yadong.zhang/JustAuth/" title="API文档">
21
		<img src="https://img.shields.io/badge/Api%20Docs--1.15.1-latest-orange" ></img>
智布道's avatar
智布道 已提交
22 23 24
	</a>
	<a target="_blank" href="https://docs.justauth.whnb.wang" title="参考文档">
		<img src="https://img.shields.io/badge/Docs-latest-blueviolet.svg" ></img>
智布道's avatar
智布道 已提交
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
	</a>
	<a href="https://codecov.io/gh/zhangyd-c/JustAuth">
		<img src="https://codecov.io/gh/zhangyd-c/JustAuth/branch/master/graph/badge.svg" />
	</a>
	<a href='https://gitee.com/yadong.zhang/JustAuth/stargazers'>
	  <img src='https://gitee.com/yadong.zhang/JustAuth/badge/star.svg?theme=white' alt='star'></img>
	</a>
	<a target="_blank" href='https://github.com/zhangyd-c/JustAuth'>
		<img src="https://img.shields.io/github/stars/zhangyd-c/JustAuth.svg?style=social" alt="github star"></img>
	</a>
</p>
<p align="center">
	<strong>开源地址:</strong> <a target="_blank" href='https://gitee.com/yadong.zhang/JustAuth'>Gitee</a> | <a target="_blank" href='https://github.com/zhangyd-c/JustAuth'>Github</a>
</p>
<p align="center">
    <strong>QQ群:</strong>230017570
</p>
<p align="center"> 
    <strong>文档更新日期:</strong> {docsify-updated}
</p>

## 简介

JustAuth,如你所见,它仅仅是一个**第三方授权登录****工具类库**,它可以让我们脱离繁琐的第三方登录SDK,让登录变得**So easy!**

## 特点

废话不多说,就俩字:

54
1. **全**:已集成十多家第三方平台(国内外常用的基本都已包含),仍然还在持续扩展中([开发计划](https://gitee.com/yadong.zhang/JustAuth/issues/IUGRK))!
智布道's avatar
智布道 已提交
55 56
2. **简**:API就是奔着最简单去设计的,尽量让您用起来没有障碍感!

智布道's avatar
智布道 已提交
57 58 59 60
## 项目关注度趋势

[![Stargazers over time](https://starchart.cc/justauth/JustAuth.svg)](https://starchart.cc/justauth/JustAuth)

智布道's avatar
智布道 已提交
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
## 参与&贡献

JustAuth的发展离不开朋友们的支持,时至今日,JustAuth已渐趋完善,但仍有很大的改善空间。欢迎各位朋友为JustAuth贡献一份力量。

### 提供bug或建议

- [Gitee](https://gitee.com/yadong.zhang/JustAuth/issues)
- [Github](https://github.com/justauth/JustAuth/issues)

如果你正在使用JustAuth,可以在这儿留下你的足迹,获得优先推送、曝光

- [Gitee](https://gitee.com/yadong.zhang/JustAuth/issues/IZ2T7)
- [Github](https://github.com/justauth/JustAuth/issues/17)

### 贡献代码的步骤
智布道's avatar
智布道 已提交
76 77

1. fork本项目到自己的repo
智布道's avatar
智布道 已提交
78 79 80
2. 把fork过去的项目也就是你仓库中的项目clone到你本地
3. 修改代码(`dev`分支)
4. commit后push到自己的仓库
智布道's avatar
智布道 已提交
81
5. 发起PR(pull request) 请求,提交到`dev`分支
智布道's avatar
智布道 已提交
82 83 84
6. 等待合并

### 注意事项
智布道's avatar
智布道 已提交
85

智布道's avatar
智布道 已提交
86 87 88 89
1. JustAuth只接受集成**OAuth2.0**的平台
2. 建议安装“**阿里编码规约**”插件,然后进行开发
3. 提交PR前请格式化好自己的代码
4. 注释规范,自定义的方法一定要加上:方法说明、参数说明、返回值说明等
智布道's avatar
智布道 已提交
90

智布道's avatar
智布道 已提交
91
## 功能尝鲜
智布道's avatar
智布道 已提交
92 93 94 95 96

JustAuth一共有两个主要分支:
- 线上版分支(master):稳定版,发布版就是这个分支的代码
- 开发版分支(dev):不保证稳定,新功能都会优先推送到该分支,对于想尝鲜的朋友,可以直接下载代码,然后源码编译dev分支

智布道's avatar
智布道 已提交
97 98 99 100 101
## 开源推荐
- `spring-boot-demo` 深度学习并实战 spring boot 的项目: [https://github.com/xkcoding/spring-boot-demo](https://github.com/xkcoding/spring-boot-demo)
- `mica` SpringBoot 微服务高效开发工具集: [https://github.com/lets-mica/mica](https://github.com/lets-mica/mica)
- `pig` 宇宙最强微服务认证授权脚手架(架构师必备): [https://gitee.com/log4j/pig](https://gitee.com/log4j/pig)
- `SpringBlade` 完整的线上解决方案(企业开发必备): https://gitee.com/smallc/SpringBlade
智布道's avatar
智布道 已提交
102

智布道's avatar
智布道 已提交
103 104 105 106 107 108
## 捐赠

| 支付宝  | 微信  |
| :------------: | :------------: |
| <img src="https://gitee.com/yadong.zhang/static/raw/master/qrcode/zfb_code.png" width="200"/> | <img src="https://gitee.com/yadong.zhang/static/raw/master/qrcode/wx_code.png" width="200" /> |