Skip to content

Commit

Permalink
Add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
Mantas Domaševičius committed May 28, 2017
1 parent 8677c4b commit 5550842
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2015 Cory House

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
38 changes: 38 additions & 0 deletions README.MD
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Spring boot + groovy + ReactJS

Minimalistic bootstrap of libraries to kick-start development. Groovy is added into the
mix for `spock` tests and to avoid tedious object mappings,
constructions and to allow for more readable code.

# What's inside?

- Spring Boot
- Groovy support
- Acceptance test module for REST API testing
- Docker/Docker-Compose ready
- ReactJS + Redux UI up and ready (from [react-slingshot](https://github.com/coryhouse/react-slingshot))
- Additionally added redux-logger, ant-design and proxy
- Travis ready :)

# How to use?

- Pre-requisits:
- JDK 8
- Docker/Docker-Compose
- Node 7 (only if you wish to work on front-end)

- Usage:
- `git clone git@github.com:mdomasevicius/springboot-boilerplate.git`
- `gradlew build` - build
- `gradlew build -Pacceptance` - build and run acceptance test (requires docker/docker-compose)

# Acknowledgements
- No security - since it varies per project basis
- No datasource capabilities - since it varies per project basis
- Hypermedia support is to be added but would be nice to have
- Jackson is not configured to handle some java types like `java.time.*`
- May need to configure [dependency-management-plugin](https://github.com/spring-gradle-plugins/dependency-management-plugin)

# Notes
- Rename packaging accordingly to you project domain.
- Anyone is welcome to contribute, just raise a PR

0 comments on commit 5550842

Please sign in to comment.