Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sczyh30/vertx-blueprint-todo-backend
Vert.x Blueprint Project - A reactive todo-backend implementation using Vert.x and various persistence
https://github.com/sczyh30/vertx-blueprint-todo-backend
asynchronous reactive-programming restful-api rxjava2 vertx
Last synced: 3 months ago
JSON representation
Vert.x Blueprint Project - A reactive todo-backend implementation using Vert.x and various persistence
- Host: GitHub
- URL: https://github.com/sczyh30/vertx-blueprint-todo-backend
- Owner: sczyh30
- License: apache-2.0
- Created: 2016-04-25T15:52:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-05-23T22:45:21.000Z (over 4 years ago)
- Last Synced: 2024-09-27T07:40:55.159Z (3 months ago)
- Topics: asynchronous, reactive-programming, restful-api, rxjava2, vertx
- Language: Java
- Homepage:
- Size: 1.3 MB
- Stars: 180
- Watchers: 18
- Forks: 59
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- vertx-awesome - Vert.x blueprint - TODO backend - favicon.svg" alt="(stack)" title="Vert.x Stack" height="16px"> - The official Vert.x blueprint showing how to build a backend for a TODO application. (Examples)
README
# Vert.x Blueprint - Todo Backend
[](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)):
You can also run it with [the todo backend frontend client](http://www.todobackend.com/client/index.html):
