add guide for setup start up environment (#28)

1. add guide for setup start up environment
2. unify project name  to START-DB

Author: zsc347

.gitignore

@@ -27,3 +27,6 @@ target
 # idea ignore
 .idea
 *.iml
+
+# generated file
+**/dependency-reduced-pom.xml

CONTRIBUTING.md

@@ -1,33 +1,48 @@
-# Contributing to Start DB
+# Contributing to START-DB
+
+### Running environment setup
+
+Running environment need to be setup before build or test START-DB.
+
+Please follow [Docker Setup](docker/docker-compose.md) and confirm
+
+```
+mvn clean package
+```
+
+run successfully.
 
 ### Importing the project into IntelliJ IDEA
-Start DB builds using Java 8. When importing into IntelliJ you will need
+
+START-DB builds using Java 8. When importing into IntelliJ you will need
 to define an appropriate SDK.or more details
 on defining an SDK in IntelliJ please refer to [their documentation](https://www.jetbrains.com/help/idea/sdk.html#define-sdk).
 
-You can import the Start DB project into IntelliJ IDEA via:
+You can import the START-DB project into IntelliJ IDEA via:
 
 - Select **File > Open**
 - In the subsequent dialog navigate to the root `pom.xml` file
 - In the subsequent dialog select **Open as Project**
 
 #### Checkstyle
-You can install [Checkstyle] plugin to check the Start DB code.
+
+You can install [Checkstyle] plugin to check the START-DB code.
 
 1. Open **File > Settings> Tools > CheckStyle**
 2. Select CheckStyle version `9.3`
 3. Import CheckStyle file `conventions/checkstyle.xml`
 4. Click "OK"
 
 ### Formatting
-Start DB code is automatically formatted with [spotless], backed by the Eclipse formatter. You can do the same in IntelliJ with the [Eclipse Code Formatter] so that you can apply the correct formatting directly in
+
+START-DB code is automatically formatted with [spotless], backed by the Eclipse formatter. You can do the same in IntelliJ with the [Eclipse Code Formatter] so that you can apply the correct formatting directly in
 your IDE. Or import it as IntelliJ code style setting.
 
 1. Open **File > Settings/Preferences > Code Style > Java**
 2. Gear icon > Import Scheme > Eclipse XML Profile
 3. Navigate to the file `conventions/eclipse-formatter.xml`
 4. Click "OK"
 
-[Checkstyle]: https://plugins.jetbrains.com/plugin/1065-checkstyle-idea
+[checkstyle]: https://plugins.jetbrains.com/plugin/1065-checkstyle-idea
 [spotless]: https://github.com/diffplug/spotless
-[Eclipse Code Formatter]: https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter
+[eclipse code formatter]: https://plugins.jetbrains.com/plugin/6546-eclipse-code-formatter

conventions/eclipse-formatter.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <profiles version="13">
-  <profile kind="CodeFormatterProfile" name="'Start DB Style'" version="13">
+  <profile kind="CodeFormatterProfile" name="'START-DB Style'" version="13">
     <setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert"/>
     <setting id="org.eclipse.jdt.core.formatter.disabling_tag" value="@formatter:off"/>
     <setting id="org.eclipse.jdt.core.formatter.insert_space_after_comma_in_annotation" value="insert"/>

docker/docker-compose.md

@@ -0,0 +1,11 @@
+## Using docker-compose to config startup environment
+
+please install docker and docker-compose first : https://docs.docker.com/compose/install/
+
+#### Running environment start up
+
+1. Access the docker folder (`cd docker`)
+1. launch the environment by docker compose (`docker-compose up -d`)
+1. access mysql as you want
+1. if there is conflict on port, just modify the corresponding port defined in docker-compose.yml and then launch docker compose again(`docker-compose up -d`)
+1. if you want to stop the environment, use command `docker-compose down`

docker/docker-compose.yml

@@ -0,0 +1,11 @@
+version: '3.3'
+services:
+  mysql:
+    image: 'mysql:5.7'
+    environment:
+      MYSQL_ROOT_PASSWORD: start_db
+      MYSQL_USER: start_db
+      MYSQL_PASSWORD: start_db
+      MYSQL_DATABASE: meta_data
+    ports:
+      - '3306:3306'