How to deploy Angular 6 + Spring Boot app as single deployment unit ?
In this article, we are going to check how to deploy Angular 6 & Spring Boot REST application as single deployment unit but however best practice is to separate Spring boot and Angular application so that we decouple the client code and server code, hence the application becomes highly scalable and manageable.But sometimes there could be scenarios for ex. small application/teams it is advisable to package as single unit and deploy them.In this article, we are going to check how to use maven resources plugin and spring boot jar packaging to build and deploy as single unit.
Install Prerequisites
In the first part of the article, we would be creating new Angular 6 client using Angular CLI & install prerequisites.We would be installing Node.js which is a cross platform runtime system and runtime environment for applications written in JavaScript language and npm package manager for downloading packages.
- Install Node.js from here
- Confirm Node.js version by following commands
node -v & npm –v
- Install Angular CLI using following command and we would be creating creating angular apps using CLI interface.
npm install -g @angular/cli
- Confirm if the installation is successful using following command.
ng -v
- With this step, Angular installation is complete.Next step is to create simple spring boot project.
Create new Spring Boot and Angular 6 application
- Use start.spring.io or create new project from STS
- Create new controller with request mapping
/api/hello
and do maven compile to check if build is success.
- Create new angular client using
ng new
command with angular CLI
- Check if we are able to start using
npm start
command from the workspace.
- We should be able to see the new application http://localhost:4200
- Next step is to import it to STS and modify few items. From STS,use Import from Projects option to export angular application in to STS.
- Once import is complete,on project settings exclude
node_modules
folder & click on apply. We wouldn’t neednode_modules
folder because it would be generated during build process.
- Resultant folder post exclusion of
node_modules
folder.
- Modify
app.component.css
to update color as 'black' (optional step)
- Modify
app.component.ts
to update title as required (optional step)
- Post modifications, run
npm start
to view the changes
- Verify if you’re able to see modifications.
- Use
ng build –prod
command for generating production build artifacts.
- Post generation of production build you should see new folder named ‘dist’.
- Now we have both static sources (angular application) dist folder & Spring Boot artifacts.
Use Maven resource plugin to package as single jar
- Next step is to use maven resource plugin to copy all files from dist folder to
/src/main/resources/static
folder to Spring Boot Project. Following is the POM configuration<plugin> <artifactId>maven-resources-plugin</artifactId> <executions> <execution> <id>copy-resources</id> <phase>validate</phase> <goals><goal>copy-resources</goal></goals> <configuration> <outputDirectory>${build.directory}/classes/static/</outputDirectory >
<resources>
<resource>
<directory>../angular6-client/dist</directory>
</resource>
</resources>
</configuration>
</execution>
</executions>
</plugin>
- On Maven clean build, you should see jar with both Angular 6 & Spring Boot application on the target folder.
- Execute with
Java –jar
command to launch the application, you should see the Angular application served from static folder.
- Spring Boot application can also be launched from the same app.
Congrats! today we have learnt how to use maven resources plugin and spring boot jar packaging to build and deploy as single unit.
Additional Resources
Originally published at @upnxtblog.