Backend on AgStack Documentation

Getting started

Mon, 01 Jan 0001 00:00:00 +0000

Running the INATrace backend on a development machine. Configuration is covered separately in Configuration .

Requirements

Java 17 or higher
Maven 3.8.5
MySQL 8.4.11

Optional

Docker
Mailhog

How to run

Clone the repository
Import as maven project to your preferred IDE
Prepare environment
1. Create database
2. (OPTIONAL) Email testing
3. Spring configuration
Run INATraceBackendApplication.java

Create database

Spin up a container:

docker run --name inatrace-mysql -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=inatrace -e MYSQL_USER=inatrace -e MYSQL_PASSWORD=inatrace -p 3306:3306 -d mysql:8.4.11

Tables will be created and prefilled with starter data on application startup.

Configuration

Mon, 01 Jan 0001 00:00:00 +0000

Every property the backend reads, grouped by what it configures.

Spring uses application.properties file stored in src/main/resources for configuration. A template is provided, see instructions below.

Make a copy of application.properties.template and save it as application.properties
Fill the missing values

NOTE: The values defined below are applicable for a local development environment. For other environments, change the values accordingly.

Datasource

INATrace.database.name: inatrace
spring.datasource.username: inatrace
spring.datasource.password: inatrace

SMTP

spring.mail.protocol: smtp
spring.mail.host: localhost
spring.mail.port: 1025
spring.mail.username
spring.mail.password
spring.mail.properties.mail.smtp.ssl.checkserveridentity: false
spring.mail.properties.mail.smtps.auth: false

Email template

INAtrace.mail.template.from: info@inatrace.com
INAtrace.mail.redirect
INAtrace.mail.sendingEnabled: true (false by default)
INATrace.loginManager.mail: registrations@inatrace.com (Email address to receive notifications for new registrations)
INAtrace.info.mail: info@inatrace.com (Contact email)

Security

INATrace.auth.jwtSigningKey: sign (Key for signing JWT tokens)
INATrace.requestLog.token: token (Key for authorizing log requests)

Storage

INATrace.fileStorage.root: Path on local filesystem for saving images, documents, etc. (e.g. C:\\Users\\Name\\inatrace-backend or /home/name/inatrace-backend)

Exchange rates API

INAtrace.exchangerate.apiKey: API key for exchange rate service. Create a free account at https://exchangeratesapi.io to get an API key.

Beyco integration

INATrace supports integration with the Beyco platform. This allows users to create Beyco offers automatically from INATrace stock orders. For more info about Beyco, please go to: https://beyco.nl. This integration is optional. Integration properties are following:

API

Mon, 01 Jan 0001 00:00:00 +0000

How clients authenticate, where the generated OpenAPI definition lives, and what the common requests look like.

OpenAPI

Resources are annotated with Swagger annotations. After the application is started, the Swagger service definition JSON is served at http://localhost:8080/v3/api-docs, and Swagger UI is served at http://localhost:8080/swagger-ui.html .

Both live at the root of the server rather than under /api. Every endpoint the application itself defines is published under /api — PrefixedApiRequestHandler adds that prefix to the mappings in the com.abelium packages — but springdoc’s own endpoints are not touched by it. http://localhost:8080/api/swagger-ui.html does not exist.

Database

Mon, 01 Jan 0001 00:00:00 +0000

Connection parameters, the entity model, and how schema migrations run.

Version

MySQL 8.4.11

Connection

If you are using a database management tool, use the following parameters to create a connection:

Hostname: localhost
Port: 3306
Database: inatrace
Username: root
Password: root
Use SSL: true
Driver settings:
- allowPublicKeyRetrieval: true

Entities

A complete list of entities is available here .

Below is the entity graph for an initialized INATrace database. The full-sized vector image can be found here .

Building

Mon, 01 Jan 0001 00:00:00 +0000

Producing a runnable jar and a Docker image.

To build an executable jar run the following command in the project root directory:

mvn clean install

Docker image

Base

eclipse-temurin:17-jre

Since only the major version is specified, the build process will always pull the latest minor and patch versions automatically.

Command syntax

To build and tag a Docker image run docker-build.sh in the project root directory. The script runs mvn clean package then builds and tags a Docker image with the resulting jar.