This collection of templates allow you to quickly build a Spring Boot microservice that serves both a REST API and a web based Admin UI.
At present it can be used to build microservices that have the following features:
- Basic CRUD operations (create, read, update and delete).
- Basic user authentication and authorization.
- Simple Web Admin interface.
- Markdown display and edit.
- Markdown document builder.
- File upload to AWS S3.
In its current state it should not be used for a production microservice. Your contributions are welcome. With the help of the Spring Boot community the goal is to reach a point where it can be used for production level applications. Until then, it is functional and can certainly serve to build prototype microservices.
This library is specifically written for use with the Entity Compiler. It is recommended to first go through the Entity Compiler Tutorial before trying to understand this library.
The following are the major technologies are used by this library:
| Name | Description | Link |
|---|---|---|
| Spring Boot | This is an extensive Java-based framework for building microservices. | https://spring.io/projects/spring-boot |
| Thymeleaf | The admin console uses Thymeleaf to dynamically create the final HTML for most of the web pages. Thymeleaf has basically two parts, a Java component that provides the data for the construction of the HTML and an HTML file that contains special constructs that help you build the final HTML from data provided by the Java component. | http://thymeleaf.org |
| Bootstrap | This is a javascript based framework for building web sites. It supports many types of form elements, as well as elements for layout, content, etc. | https://getbootstrap.com/docs/5.0 |
| InscrybMDE | Markdown editor - "A drop-in JavaScript textarea replacement for writing beautiful and understandable Markdown". | https://github.com/Inscryb/inscryb-markdown-editor |
| Marked | Renders markdown text into HTML. This is used to display markdown content on the web page. | https://marked.js.org |
The easiest way to get started is to install a sample project. This can be done using the Entity Compiler's setup command. To do this you first need to have the Entity Compiler installed. See https://github.com/entityc/entity-compiler for details.
On a command line run the following command:
ec setup github:entityc/ec-springboot-lib:production/setups/BasicWebAppThis will start the process of installing a basic spring boot application. It will prompt you to enter information about the microservice it is creating for you. Many of the prompts have default values; you can either just hit return to get the default value or enter another value.
It will then print out instructions on how to bring up the microservice.
All projects of the EntityC Organization are under the BSD 3-clause License.
See LICENSE.md for details.
Contributors are welcome. Before contributing please read the following Contributing Guidelines.
The Code of Conduct governs how we behave in public or in private whenever the project will be judged by our actions. We expect it to be honored by everyone who contributes to this project.
See Code of Conduct for details.