Overview

v1.1.7

Utilities and apis for the backends based on the Spring Boot framework

Implementation

Version catalog

[versions]
equinox-backend = "1.1.8"
equinox = "1.1.9"

[libraries]
equinox-backend = { module = "io.github.n7ghtm4r3:equinox-backend", version.ref = "equinox-backend" }
equinox-core = { module = "io.github.n7ghtm4r3:equinox-core", version.ref = "equinox" }

Gradle

Add the JitPack repository to your build file

• Add it in your root build.gradle at the end of repositories

  repositories {
      ...
      maven { url 'https://jitpack.io' }
  }
  

  Gradle (Kotlin)

  repositories {
      ...
      maven("https://jitpack.io")
  }
  

• Add the dependency

  dependencies {
  
      // implement the backend utilities
      implementation 'io.github.n7ghtm4r3:equinox-backend:1.1.8'
  
      // implement the core utilities
      implementation 'io.github.n7ghtm4r3:equinox-core:1.1.9'
  }
  

  Gradle (Kotlin)

  dependencies {
  
      // implement the backend utilities
      implementation("io.github.n7ghtm4r3:equinox-backend:1.1.8")
  
      // implement the core utilities
      implementation("io.github.n7ghtm4r3:equinox-core:1.1.9")
  }
  

  Gradle (version catalog)

  dependencies {
  
      // implement the backend utilities
      implementation(libs.equinox.backend)
  
      // implement the core utilities
      implementation(libs.equinox.core)
  }
  

APIs available

Batch

• EquinoxItemsHelper
  Executes batch database operations such as insertion, deletion, and synchronization

• BatchSynchronizationProcedure
  Defines reusable and compacted synchronization procedures

Database

• IndexesCreator
  Automatically creates indexes for custom database tables

• FilteredQuery
  Builds dynamic queries with filter parameters leverages regex expressions

• SQLConstants
  Collection of constants used in the SQL context

Miscellaneous

• ResourcesProvider
  Manages static resources to serve to client applications

• EquinoxEvents
  Facilitates event sharing and collection between backend services

Basic environment available

Equinox gives a basic out-of-the-box environment to directly create a SpringApplication following the Equinox implementation philosophy to automatically manage some recurring operations such the users related requests or the inputs validation. You can take a look here to check how it works and how to implement it on your own backend

Configure your backend

To configure your backend as you need you can follow this guide to directly copy the @Component classes you need and implement them in your backend instance, personal advice is put them in a folder named configuration for clean implementation and better readability as follows:

com.your.package
└── configuration
   └── config_class
   └── config_class
   └── config_class
   └── ...

Annotations available

This module provides a set of annotations that can be used to improve code readability and maintainability. You can explore them here