https://github.com/BillyYccc/vertx-postgresql-starter

Starting a monolithic CRUD RESTful Web Service with Vert.x stack and postgreSQL
https://github.com/BillyYccc/vertx-postgresql-starter

docker docker-compose gradle java8 postgresql reactive restful rxjava2 vertx vertx-web

Last synced: about 1 month ago
JSON representation

Starting a monolithic CRUD RESTful Web Service with Vert.x stack and postgreSQL

• Host: GitHub
• URL: https://github.com/BillyYccc/vertx-postgresql-starter
• Owner: BillyYccc
• License: mit
• Created: 2017-10-21T04:32:06.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2021-11-07T01:03:22.000Z (about 3 years ago)
• Last Synced: 2024-11-13T02:51:59.947Z (about 1 month ago)
• Topics: docker, docker-compose, gradle, java8, postgresql, reactive, restful, rxjava2, vertx, vertx-web
• Language: Java
• Homepage:
• Size: 262 KB
• Stars: 34
• Watchers: 3
• Forks: 8
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• vertx-awesome - Vert.x PostgreSQL Starter - A starter to build a monolithic CRUD RESTful Web Service with Vert.x stack and PostgreSQL. (Examples)

README

        
# vertx-postgresql-starter

This is a starter to build a [monolithic](http://microservices.io/patterns/monolithic.html) CRUD RESTful Web Service with [Vert.x](http://vertx.io/) stack and [postgreSQL](https://www.postgresql.org/).

It leverages [Gradle](https://gradle.org/) to build and [Docker](https://www.docker.com/) to boost deployment.

[![Vert.x Version](https://img.shields.io/badge/Vert.x-3.6.2-blue.svg)](https://github.com/eclipse/vert.x)

[![Build Status](https://travis-ci.org/BillyYccc/vertx-postgresql-starter.svg?branch=master)](https://travis-ci.org/BillyYccc/vertx-postgresql-starter)

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/300d3703677b4cc3ace9e30ef6438586)](https://www.codacy.com/app/BillyYccc/vertx-postgresql-starter?utm_source=github.com&utm_medium=referral&utm_content=BillyYccc/vertx-postgresql-starter&utm_campaign=Badge_Grade)

[![license](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/BillyYccc/vertx-postgresql-starter/blob/master/LICENSE)

## Prerequisites

* JDK 8+

* Docker

* Docker-compose

## Build

##### 1. Git clone this repo

`git clone https://github.com/BillyYccc/vertx-postgresql-starter.git $PROJECT_NAME`

##### 2. Go to the directory of the project

`cd $PROJECT_NAME`

##### 3. Generate a fat jar

`./gradlew shadowJar`

After a successful build, a fat jar file is generated in directory `$PROJECT_NAME/build/libs`

## Deployment

##### Just one-key deploy with docker-compose

`docker-compose up --build`

## Project

##### REST API

The project takes an easy example with an mini library, the REST API specification is [here](API_SPEC.md). 

##### Domain Logic

The Domain Logic is organized with [Transaction Script](https://martinfowler.com/eaaCatalog/transactionScript.html).

##### Database Degisn

![database](database.png)