Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 1.09 KB

README.md

File metadata and controls

57 lines (41 loc) · 1.09 KB
Raw

rikishi backend

Requirements

Structure

The convention which is used in the project is Separation by layers (e.g. service layer, repository layer, controller layer etc.)

For example:

com
|-- example
|    `-- sampleapplication
|        |-- controller
|            |-- HelloWorldController.java
|            |-- LoginController.java
|        |-- model
|            |-- User.java
|            |-- Group.java
|        |-- service
|            |-- UserService.java
|        |-- repository
|            |-- UserRepository.java

Some rules:

  • Data classes related to business logic should be normally placed in the model package
  • Database-related data classes should be placed in the model/entity package
  • REST-related data classes should be placed in the model/rest package

Note

These rules are not strict and can be violated in certain cases.

Install and run

./gradlew bootRun

Development

Test

./gradlew test

Lint

./gradlew spotlessApply