项目作者: nicefishcn

项目描述 :
nicefish-backend is a rapid development framework for business backend system.
高级语言: Java
项目地址: git://github.com/nicefishcn/nicefish-backend.git
创建时间: 2017-06-26T03:02:30Z
项目社区:https://github.com/nicefishcn/nicefish-backend

开源协议:MIT License

下载


nicefish-backend

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

Build Status
Codecov
License

architecture

  1. j2ee
  2. mysql
  3. rest

dependencies: framework and libraries

j2ee

  1. spring/spring-boot
  2. mybatis/generator
  3. spring-mvc
  4. fastjson
  5. slf4j
  6. druid
  7. shiro
  8. swagger
  9. lombok

tool

  1. maven
  2. mybatis-generator
  3. Swagger-Bootstrap-UI
  4. tomcat/jetty
  5. mysql
  6. script tools for Linux/Mac/Windows

get started

clone project

you can clone it in your console from git oschina:

  1. git clone http://git.oschina.net/nicefish/nicefish-backend

or from github:

  1. git clone https://github.com/nicefishcn/nicefish-backend

build project

build it:

  1. mvn package #or mvn install

start nicefish application

  1. start your mysql server, and execute docs/sql/nicefish.sql
  2. then run project use:
  1. 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:
  1. you can access SwaggerUI and test rest api:
  1. screenshot


On console:

  1. $ curl -c cookie.txt "http://localhost:8080/auth/login?userName=kimmking&password=123456"
  2. {"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$
  3. $ curl -b cookie.txt http://localhost:8080/user/list
  4. [{"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:

  1. sh env.sh #on Windows, just use: env.bat
  2. 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