README.md · yhr577/nicefish-backend

[TOC]

# nicefish-backend
nicefish-backend is a rapid development framework for business backend system.

[![Build Status](https://travis-ci.org/nicefishcn/nicefish-backend.svg?branch=master)](https://travis-ci.org/nicefishcn/nicefish-backend)
[![Codecov](https://codecov.io/gh/nicefishcn/nicefish-backend/branch/master/graph/badge.svg)](https://codecov.io/gh/nicefishcn/nicefish-backend/branch/master)
[![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

## architecture
1. j2ee
2. mysql
3. rest

## dependencies: framework and libraries

### j2ee
1. spring/spring-boot ![](https://img.shields.io/badge/springboot-done-green.svg?style=plastic)
2. mybatis/generator ![](https://img.shields.io/badge/mybatis-done-green.svg?style=plastic)
3. spring-mvc ![](https://img.shields.io/badge/springmvc-done-green.svg?style=plastic)
4. fastjson ![](https://img.shields.io/badge/fastjson-done-green.svg?style=plastic)
5. slf4j ![](https://img.shields.io/badge/slf4j-done-green.svg?style=plastic)
6. druid ![](https://img.shields.io/badge/druid-done-green.svg?style=plastic)
7. shiro ![](https://img.shields.io/badge/shiro-done-green.svg?style=plastic)
8. swagger ![](https://img.shields.io/badge/swagger-done-green.svg?style=plastic)
9. lombok ![](https://img.shields.io/badge/lombok-done-green.svg?style=plastic)

### tool
1. maven ![](https://img.shields.io/badge/maven-done-green.svg?style=plastic)
2. mybatis-generator ![](https://img.shields.io/badge/generator-done-green.svg?style=plastic)
3. Swagger-Bootstrap-UI ![](https://img.shields.io/badge/swagger-done-green.svg?style=plastic)
4. tomcat/jetty ![](https://img.shields.io/badge/tomcat-done-green.svg?style=plastic)
5. mysql ![](https://img.shields.io/badge/mysql-done-green.svg?style=plastic)
6. script tools for Linux/Mac/Windows ![](https://img.shields.io/badge/Tools-done-green.svg?style=plastic)

## get started

### clone project
you can clone it in your console from git oschina:
```
git clone http://git.oschina.net/nicefish/nicefish-backend
```
or from github:
```
git clone https://github.com/nicefishcn/nicefish-backend
```
### build project
build it:

```
mvn package #or mvn install
```

### start nicefish application
1. start your mysql server, and execute docs/sql/nicefish.sql
2. then run project use:

```
sh run.sh #on Windows, just use: run.bat
```

### access demo
then you can access nicefish application in webbrowser or on console now:
1. you can login && list users:
In webbrowser, use this url:
- http://localhost:8080/auth/login?userName=kimmking&password=123456
- http://localhost:8080/user/list

2. you can access SwaggerUI and test rest api:
- http://localhost:8080/doc.html

3. screenshot
![](https://git.oschina.net/nicefish/nicefish-backend/raw/master/docs/screenshot/swagger01.jpg)
![](https://git.oschina.net/nicefish/nicefish-backend/raw/master/docs/screenshot/swagger02.jpg)
![](https://git.oschina.net/nicefish/nicefish-backend/raw/master/docs/screenshot/swagger03.jpg)

On console:
```
$ curl -c cookie.txt "http://localhost:8080/auth/login?userName=kimmking&password=123456"
{"userId":"ca11816f-8480-469f-b33e-c705bb7d29ae","userName":"kimmking","password":"...","email":"kimmking@163.com","realName":null,"nickName":null,"qq":null,"weixin":null,"cellPhone":null,"userDesc":null,"upId":null,"status":null,"regTime":1498461050000,"lastloginTime":null,"ename":null}bogon:nicefish-backend kimmking$

$ curl -b cookie.txt http://localhost:8080/user/list
[{"userId":"ca11816f-8480-469f-b33e-c705bb7d29ae","userName":"kimmking","password":"...","email":"kimmking@163.com","realName":null,"nickName":null,"qq":null,"weixin":null,"cellPhone":null,"userDesc":null,"upId":null,"status":null,"regTime":1498461050000,"lastloginTime":null,"ename":null}]bogon:nicefish-backend kimmking$

```

## development
if you want to regenerate all mybatis models and mappers, execute in console:
```
sh env.sh #on Windows, just use: env.bat
sh gen.sh #on Windows, just use: gen.bat
```

- env.sh/env.bat to prepare required plugins in this project.
- gen.sh/gen.bat to generate mybatis codes from mysql.

### contribute
If you find any bug or some suggestion, click: [ISSUE-GIT-OSCHINA](http://git.oschina.net/nicefish/nicefish-backend/issues)

yhr577/nicefish-backend

简介

发行版

贡献者

近期动态

yhr577/nicefish-backend .gitee-modal { width: 500px !important; }

简介

发行版

贡献者

近期动态

搜索帮助

yhr577/nicefish-backend