https://github.com/pmlopes/slush-vertx

https://github.com/pmlopes/slush-vertx

boilerplate generator scaffold slush slushgenerator vertx

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/pmlopes/slush-vertx
• Owner: pmlopes
• Archived: true
• Created: 2017-04-19T12:42:00.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-03-26T10:34:45.000Z (almost 6 years ago)
• Last Synced: 2024-09-22T12:03:02.772Z (3 months ago)
• Topics: boilerplate, generator, scaffold, slush, slushgenerator, vertx
• Language: JavaScript
• Size: 521 KB
• Stars: 36
• Watchers: 10
• Forks: 4
• Open Issues: 8
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# This project has been replaced with https://github.com/pmlopes/vertx-starter

# slush-vertx

[![NPM](https://nodei.co/npm/slush-vertx.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/slush-vertx/)

[![Twitter](https://img.shields.io/twitter/url/https/github.com/pmlopes/slush-vertx.svg?style=social)](https://twitter.com/intent/tweet?text=Wow:&url=%5Bobject%20Object%5D)

Scaffold with [Slush][slush-url] your new Vert.x application!

slush-vertx is a collection of template driven code generators to scaffold Vert.x projects based on language and build tool used.

## Generators

| Generator | Description | Java | Kotlin | Javascript | Groovy | Ruby |

|-----------|-------------|------|--------|------------|--------|------|

| **Vert.x Starter project** | Generate an empty project configured for Vert.x 3 Framework |:heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |

| **Vert.x Web Server Starter** | Generate a skeleton with sources and tests for Vert.x 3 Web powered REST server | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :x: | :x: |

| **Vert.x Web Server OpenAPI project** | Generate a skeleton based on Swagger 2/OpenAPI 3 specification with sources and tests for Vert.x 3 Web powered REST server | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: |

| **Vert.x Web Client OpenAPI project** | Generate a client based on a Swagger 2/OpenAPI 3 specification | :heavy_check_mark: | :heavy_check_mark: | :x: | :heavy_check_mark: | :x: |

List of supported build tools:

* Maven

* Gradle

* NPM

* NPM with jar packaging (thanks to [Vert.x Webpack plugin](https://github.com/pmlopes/webpack-vertx-plugin))

If you want to add your own generator and/or build tool give a look at [how to contribute](https://github.com/pmlopes/slush-vertx/wiki/How-to-contribute)

## Install

1. Install [`gulp.js`][gulp-url]

2. Install [Slush][slush-url]

3. Install the [`slush-vertx`][generator-url] generator

```sh

$ npm install -g gulp slush slush-vertx

```

## Usage

Example of Vert.x Starter generator

[![asciicast](./demo.gif)](https://asciinema.org/a/lR23OQrMnDY6zZNggh8kgUAE4)

Example of Vert.x Web Starter generator

[![asciicast](./demo2.gif)](https://asciinema.org/a/DOZ639zUxksoMo4PxDUc12sNO)

## Contribute

If you want to add a generator, add templates to an existing generator or something else give a look at [how to contribute](https://github.com/pmlopes/slush-vertx/wiki/How-to-contribute)

## Changelog

### 0.0.3

* Fixed templates for Vert.x 3.5.0 release

* Updated `swagger2openapi`

### 0.0.2

* New life to the project!

## License

MIT © [Paulo Lopes](http://jetdrone.xyz) and [Francesco Guardiani](http://slinkydeveloper.github.io)

[slush-url]: http://slushjs.github.io

[gulp-url]: http://gulpjs.com

[generator-url]: https://github.com/pmlopes/slush-vertx