angularjs-springmvc-sample-boot

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

angularjs-springmvc-sample-boot

★ 315 Open GitHub ↗

A RESTful sample using Spring Boot, Spring MVC, Spring Data and Angular/Bootstrap.

Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

angularjs-springmvc-sample-boot
===============================

An example application using AnguarJS/Bootstrap as frontend and Spring MVC as REST API producer.

**More details about the source codes, please read the online GitBook: [Building REST APIs with Spring MVC](https://www.gitbook.com/book/hantsy/build-a-restful-app-with-spring-mvc-and-angularjs/details).**

> NOTE: This project is under maintenance, no more new features added in future. If you are looking for the new Spring Boot 2 and Angular 5, check [angular-spring-reactive-sample](https://github.com/hantsy/angular-spring-reactive-sample).

Technology stack:

* Spring Boot
* Spring MVC
* Spring Data JPA
* JPA
* Hibernate 5.2
* Spring Security
* Swagger/Swagger2Markup/Spring Rest Docs
* Spring Test/JUnit/Mockito/JBehave/RestAssured
* Lombok
* ModelMapper
* AngularJS
* Bootstrap

This version improved [the original version(without Spring Boot)](https://github.com/hantsy/angularjs-springmvc-sample), including:

* Introduction of Gulp build system to processing the static resources
* The frontend UI can be run standalone via NodeJS eco-system
* An option provided and allow you to package the static resources as part of final jar and run the application via `mvn spring-boot:run` directly

## Requirements

* JDK 8

Oracle Java 8 is required, go to [Oracle Java website](http://java.oracle.com) to download it and install into your system. 
 
  Optionally, you can set **JAVA\_HOME** environment variable and add *&lt;JDK installation dir>/bin* in your **PATH** environment variable.

* Apache Maven

Download the latest Apache Maven from [http://maven.apache.org](http://maven.apache.org), and uncompress it into your local system.

Optionally, you can set **M2\_HOME** environment varible, and also do not forget to append *&lt;Maven Installation dir>/bin* your **PATH** environment variable.

* NodeJS

NodeJS is required to build the frontend static resources.
 
  Download [NodeJS](http://nodejs.org) and install it into your local system. 
 
  After it is installed, open terminal, and using `node -v` command to confirm.
 
  ```
  node -v 
  >v4.2.2
  ```
 
  `bower` is also requried to install the runtime dependencies, and `gulp` is chosen as our build tools for the statics resources.
 
  ```
  npm install -g bower
  npm install -g gulp
  ```
 
## Get the source codes

Get a copy of the source codes into your local system.

```
git clone https://github.com/hantsy/angularjs-springmvc-sample-boot
```

## Run the project

You can use one of the following approaches to run this project.

### Run frontend UI and backend respectively

1. Run the backend API server via Spring Boot.

```
   mvn spring-boot:run
   ```

The backend APIs will run on port 9000.

2. Run the frontend UI standalone.
   
   ```
   npm install
   bower install
   gulp serve
   ```

By default, gulp serves the frontend UI static resources on port 3000.

3. Go to [http://localhost:3000](http://localhost:3000) to test it.

### Run the project via Spring Boot maven plugin
     
1. Run the following command to resovle the dependencies of the frontend static resources.
   
   ```
   npm install
   bower install
   ```

2. Run the backend API server with `spring-boot` command. The parameter `-Dstatic-ui` will copy the static resources and package into the jar archive.

```
   mvn spring-boot:run -Dstatic-ui
   ```

3. Go to [http://localhost:9000](http://localhost:9000) to test it.

If you want to explore the REST API docs online, there is a *Swagger UI* configured for visualizing the REST APIs, just go to [http://localhost:9000/swagger-ui.html](http://localhost:9000/swagger-ui.html).
 
### Generate static REST API reference documentation

I have moved the REST docs generation configuration into a standalone Maven profile.

Execute the following command to generate HTML and PDF format files for your REST APIs from Swagger API description file and Spring test code snippets(as code samples).

```
mvn clean package -Drestdocs
```

The detailed configuration is explained in [API documention](https://hantsy.gitbooks.io/build-a-restful-app-with-spring-mvc-and-angularjs/content/swagger.html) section.

When it is done, check the generated static docs in *target/asciidoc* folder, it includes a HTML 5 file(under html folder), and a PDF file(in pdf folder).

Open the pdf document in Adobe Reader, it looks like.

![pdf](https://github.com/hantsy/angularjs-springmvc-sample-boot/blob/master/restdocs.png) 
 
### Docker

You can run the project in multistage Docker building development environment, check [Multistage Builds](https://github.com/hantsy/devops-sandbox/blob/master/multistage.md).

angularjs-springmvc-sample-boot

Download

Today's picks

Was this content helpful?

Recent Feedback

angularjs-springmvc-sample-boot

Download

Today's picks

Was this content helpful?

Recent Feedback

Download README