Skip to content

Commit

Permalink
Add maven and Spring Cloud support
Browse files Browse the repository at this point in the history
Upgrade to support npm3
Update readme
  • Loading branch information
davetownsend committed Oct 31, 2016
1 parent c5ad1c9 commit 758c432
Show file tree
Hide file tree
Showing 11 changed files with 826 additions and 162 deletions.
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ root = true

[*]
indent_style = space
indent_size = 4
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
Expand Down
44 changes: 25 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
# generator-spring [![Build Status](https://secure.travis-ci.org/tomaslin/generator-spring.png?branch=master)](https://travis-ci.org/tomaslin/generator-spring)
# generator-spring

A generator for [Yeoman](http://yeoman.io).
A [Yeoman](http://yeoman.io) generator for scaffolding and bootstrapping [Spring Boot](http://projects.spring.io/spring-boot/) and [Spring Cloud](http://projects.spring.io/spring-cloud/) applications. Provides the same selectable options as [Spring Initializr](http://start.spring.io), but with and interactive CLI interface so your hands can stay where they belong, on the keyboard!


## Getting Started

### What is Yeoman?
**Install Yeoman**

Trick question. It's not a thing. It's this guy:
```
$ npm install -g yo
```

![](http://i.imgur.com/JHaAlBJ.png)
**Install generator-spring (fork)**

Basically, he wears a top hat, lives in your computer, and waits for you to tell him what kind of application you wish to create.
```
$ npm install -g davetownsend/generator-spring
```

Not every new computer comes with a Yeoman pre-installed. He lives in the [npm](https://npmjs.org) package repository. You only have to ask for him once, then he packs up and moves into your hard drive. *Make sure you clean up, he likes new and shiny things.*
**Initiate spring-generator!**

```
$ npm install -g yo
$ yo spring
```
_The interactive CLI menu will guide the way._

### Yeoman Generators

Yeoman travels light. He didn't pack any generators when he moved in. You can think of a generator like a plug-in. You get to choose what type of application you wish to create, such as a Backbone application or even a Chrome extension.

To install generator-spring from npm, run:
### Extras (Sub-generators)
Creates a REST endpoint

```
$ npm install -g generator-spring
$ yo spring:rest
```

Finally, initiate the generator:
Creates a REST endpoint with HATEOAS support *(has dependency on choosing the hateoas starter option)*

```
$ yo spring
$ yo spring:hateoas
```

### Getting To Know Yeoman
Creates an initial Thymeleaf view *(has dependency on choosing the Thyemleaf starter option)*

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced.

If you'd like to get to know Yeoman better and meet some of his friends, [Grunt](http://gruntjs.com) and [Bower](http://bower.io), check out the complete [Getting Started Guide](https://github.com/yeoman/yeoman/wiki/Getting-Started).
```
$ yo spring:route
```

## TODO
- Add the new Spring Cloud libs supported with Spring Boot 1.4.1
- Add React support. This will essentially scaffold an opinionated react SPA (webpack/es6/material-ui) as the front end.

## License

Expand Down
Loading

0 comments on commit 758c432

Please sign in to comment.