vertx-blueprint-todo-backend - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #typescript #go #rust #linux #docker #macos #cli #awesome-list #security #mcp #ios #openai

vertx-blueprint-todo-backend

(★ 185)

Vert.x Blueprint Project - A reactive todo-backend implementation using Vert.x and various persistence

File Explorer

Download Latest Version (.zip)

- config.json
- config_docker.json
- config_jdbc.json
- - todo-test-input.png
  - todo-test-result.png
  - vbptds-docker-compose-running.png
  - vert-api-test.png
  - vertx-todobackend-ui.png
- doc-en.md
- doc-en.toc.md
- doc-zh-cn.md
- doc-zh-cn.toc.md
- - gradle-wrapper.jar
  - gradle-wrapper.properties
.gitignore
.travis.yml
build.gradle
docker-compose.yml
Dockerfile
gradlew
gradlew.bat
LICENSE
README.md
settings.gradle

# Installation Guide

1. Get the code

git clone https://github.com/sczyh30/vertx-blueprint-todo-backend

Downloads the entire project code from GitHub to your computer.

cd vertx-blueprint-todo-backend

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker-compose up --build

Runs the command against the services defined in the compose file.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

Pulled directly from this repo's README.

3. Gradle (Java/Kotlin)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

gradle build -x test

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Vert.x Blueprint - Todo Backend

[![Travis Build Status](https://travis-ci.org/sczyh30/vertx-blueprint-todo-backend.svg?branch=master)](https://travis-ci.org/sczyh30/vertx-blueprint-todo-backend)

Vert.x blueprint application - A reactive todo-backend implementation using Vert.x
and various persistence (e.g. Redis or MySQL).

This repository is an introduction to basic Vert.x web RESTful service development and reactive programming. 
Detailed tutorials (both in Chinese and English) are provided below.

> Note: We've redesigned the code with reactive and functional style with **RxJava 2** and **Vert.x 3.5.x**.

## Contents

- What is Vert.x and its principles
- What is and how to use `Verticle`
- How to develop a REST API using Vert.x Web
- How to make use of **asynchronous development model**
- Reactive programming with RxJava 2
- How to use persistence such as *Redis* and *MySQL* with the help of Vert.x async data components

## Detailed Document

- [English Version](http://sczyh30.github.io/vertx-blueprint-todo-backend/)
- [中文文档](http://sczyh30.github.io/vertx-blueprint-todo-backend/cn/)

## Want to improve this blueprint ?

Forks and PRs are definitely welcome !

## Build

To build the code:

gradle build -x test

Run service locally:

- with Redis: `java -jar build/libs/vertx-blueprint-todo-backend-fat.jar -conf config/config.json`
- with MySQL: `java -jar build/libs/vertx-blueprint-todo-backend-fat.jar -conf config/config_jdbc.json`

Run with Docker Compose:

docker-compose up --build

## OpenShift

- [OpenShift Live Demo URL](http://verttodo-sczyh30.rhcloud.com/todos)
- [API Test](http://www.todobackend.com/specs/index.html?http://verttodo-sczyh30.rhcloud.com/todos)
- [Client Test](http://www.todobackend.com/client/index.html?http://verttodo-sczyh30.rhcloud.com/todos)

## API Test

Test result of the RESTful API (using [todo-backend-js-spec](https://github.com/TodoBackend/todo-backend-js-spec)):

![RESTful API Test Result](https://raw.githubusercontent.com/sczyh30/vertx-blueprint-todo-backend/master/docs/img/vert-api-test.png)

You can also run it with [the todo backend frontend client](http://www.todobackend.com/client/index.html):

![Todo Frontend](https://raw.githubusercontent.com/sczyh30/vertx-blueprint-todo-backend/master/docs/img/vertx-todobackend-ui.png)