https://github.com/veritem/springboot-template

java springboot web app template
https://github.com/veritem/springboot-template

Last synced: 3 months ago
JSON representation

java springboot web app template

• Host: GitHub
• URL: https://github.com/veritem/springboot-template
• Owner: veritem
• License: mit
• Created: 2021-03-28T08:35:03.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-14T01:05:38.000Z (11 months ago)
• Last Synced: 2024-02-14T02:24:16.900Z (11 months ago)
• Language: Java
• Homepage:
• Size: 148 KB
• Stars: 12
• Watchers: 0
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
## Spring boot project template

This is another opinionated springboot template. 

### Motivation

TLDR: I was tired of repeating the same manual tasks every time I started a new spring project. 

Many tools can help generate a new spring boot project from scratch, like Spring Initializer and many others. But Why does this template exist? Well, Springboot is a weird framework with a lot of boilerplate. 

### Getting started

> Make sure you have Java installed on your system.

1. clone the repo

```bash

git clone https://github.com/veritem/springboot-project-template.git

```

2. run `docker-compose up` to start a Postgres container

3. run  `docker exec -it  bash` to enter the container

```bash

psql -U postgres

create database ;

```

4. Open in you favorite Java IDE (IntelliJ or eclipse)

5. Open the Browser and navigate to `http://localhost:8000/swagger-ui/index.html#/`

### Features

1. Authentication with JWT

2. Role-based Authorization

3. Postgres Database Setup

4. Swagger API documentation

5. Smart Exception handling

### Toolkit

- Spring 2.4.4

- maven package manager

- Java 11 or higher

- Packaging with `jar`

- Containerized with Docker

If you run into any issues, feel free to open a new issue. Have a good rest of your day!