SLOTH 1.0

Sloth is A tool to generate scaffold code from SQL databases.You just need to specify your application database may be used. It allows for rapidly getting started on new projects. If you know what the code generator does in Ruby on Rails (RoR), Sloth works just like that, and it’s specific to JAVA language now. Sloth is always the right choice for your scaffolding needs.Sloth can help developers quickly build beautiful web applications. Read this in other languages: 中文

Features

Generate Stand-Alone SpringBoot Applications
Rapidly create a new project executable
Generate Model–View–Controller Code
Generate API DOC
Provide Many Kinds Of Data Access With JDBC
Reduce repetitive coding
- Never copy and paste boilerplate between projects again
Generate your code in less time with fewer bugs
OTHERS
- Target project generated integrate Springboot、Guava、HikariCP、Apache Commons、fastjson、swagger2、Flywaydb

Prerequisites

Before useing Sloth, you will need the following:

JDK (Java Development Kit), version 1.7 and above
Maven (Project Management Tool), version 3.0 and above
GIT

Quick Start

Step 1: Prepare Your Database And Create Your Database Structure

| host      | port | username | password | dbname |
|-----------|------|----------|----------|--------|
| 127.0.0.1 | 3306 | root     |  123456  | test   |

Step 2: Clone Sloth

git clone https://github.com/coolcooldee/sloth.git

Step 3: Into The Sloth Root Directory

cd sloth

Step 4: Maven Install

mvn clean install

Step 5: Sloth Generating

mvn exec:java -Dexec.args="-path/workspaces/mySlothProject -packagecom.test -h127.0.0.1 -P3306 -uroot -p123456 -dtest -strategyssm"  -Dexec.cleanupDaemonThreads=false -Dexec.mainClass="com.github.coolcooldee.sloth.Application"

  generate args| e.g                       | description 
  :------------| --------------------------| ---- 
  -path        |/workspaces/mySlothProject | the path where code generate  
  -projectname | mySlothProject            | the target project name  
  -package     | com.test                  | tell sloth to use the package name
  -help        | --------------------------| to see which options are available
  -strategy    | ssm                       | generattion strategy:<br/>ssd=SpringBoot + SpringData<br/>ssm=SpringMVC + Spring+MyBatis<br/>sss=SpringBoot + SpringJDBC<br/>ssj=SpringBoot + JOOQ
  -h           | 127.0.0.1                 | database host 
  -P           | 3306                      | database port 
  -u           | root                      | database username 
  -p           | 123456                    | database password
  -d           | test                      | database name

Step 6: Into Sloth Target Project Generated

cd /workspaces/mySlothProject

Step 7: Runngin Sloth Target Project

mvn clean install
mvn exec:java -Dexec.mainClass=”com.test.Application” -Dexec.cleanupDaemonThreads=false

Step 8: Open a new tab in your web browser on http://localhost:8081/apis-docs-by-sloth.html

Example

Database Tables Source

TableName |
--------- |
game |
gameRole |
gameServer |

Target Project Code

├── deploy.sh
├── mvn.sh
├── pom.xml
├── src
│   ├── main
│   │   ├── assembly
│   │   │   ├── assembly.xml
│   │   ├── java
│   │   │   ├── com
│   │   │   │   ├── sloth
│   │   │   │   │   ├── aop
│   │   │   │   │   │   ├── LogAspect.java
│   │   │   │   │   ├── Application.java
│   │   │   │   │   ├── common
│   │   │   │   │   │   ├── Page.java
│   │   │   │   │   ├── config
│   │   │   │   │   │   ├── database
│   │   │   │   │   │   │   ├── DB.java
│   │   │   │   │   │   │   ├── DBConfig.java
│   │   │   │   │   │   ├── redis
│   │   │   │   │   │   │   ├── RedisConfig.java
│   │   │   │   │   ├── controller
│   │   │   │   │   │   ├── restfulapi
│   │   │   │   │   │   │   ├── GameController.java
│   │   │   │   │   │   │   ├── GameRoleController.java
│   │   │   │   │   │   │   ├── GameServerController.java
│   │   │   │   │   ├── mapper
│   │   │   │   │   │   ├── GameMapper.java
│   │   │   │   │   │   ├── GameRoleMapper.java
│   │   │   │   │   │   ├── GameServerMapper.java
│   │   │   │   │   ├── model
│   │   │   │   │   │   ├── Game.java
│   │   │   │   │   │   ├── GameRole.java
│   │   │   │   │   │   ├── GameServer.java
│   │   │   │   │   ├── service
│   │   │   │   │   │   ├── GameRoleService.java
│   │   │   │   │   │   ├── GameServerService.java
│   │   │   │   │   │   ├── GameService.java
│   │   │   │   │   │   ├── impl
│   │   │   │   │   │   │   ├── GameRoleServiceImpl.java
│   │   │   │   │   │   │   ├── GameServerServiceImpl.java
│   │   │   │   │   │   │   ├── GameServiceImpl.java
│   │   ├── resources
│   │   │   ├── application.properties
│   │   │   ├── static
│   │   │   │   ├── apis-docs-by-sloth.html
│   │   │   │   ├── css
│   │   │   │   ├── fonts
│   │   │   │   ├── html
│   │   │   │   ├── js
│   │   │   ├── template
├── start.sh
├── stop.sh

Target Project Api Webpage

Demo http://www.dee1024.cc/apis-docs-by-sloth.html

Contributing

If you want to contribute code, we are waiting for your pull requests !

Author

Dee Qiu coolcooldee@gmail.com

Others

QQ Group 570997546

License

Sloth is licensed under the Apache License, Version 2.0 (the "License");

cloudl/sloth