reforseti

An adventure in Java. A reimplementation of site-rear in Java, Springboot.

Note: This is currently a POC. This is not intended to replace the current API Server. Reference API Document: api-ref.md

Aims

• Performance test respective APIs
• Mirror the API of site-rear as well as possible

Requirements

• Java 17 (Hint: Use sdkman for quick setup)
• Postgres DB
  • It must be database-compatible with the existing site-rear project.
• JWT-based authentication
  • it must be able to use at least the same auth methods as site-rear

Key differences

• API field names have been updated and API shape has been normalized.
  • This is just the consequence of using a strongly typed language.
• API verbs have been normalized.
  • Eg.events is now event
• JWTs expire after some time.

New

• Basic authentication has been added.
• Actuator - Health, Info and Metrics:
  • Each API Endpoint (Except root) is timed
• (Dev) Tests!

Getting started

• Install Java 17. SDKMan is a good way to start.
• Connect to local DB with ssh -L 5442:localhost:5442 -N [email protected]
• Copy and put application-local.properties into src/main/resources. It will have local DB configurations
• Use any IDE - VSCode/IntelliJ.
  • VSCode: Add the following configuration to launch.json under the configurations array:

    {
        "type": "java",
        "name": "SiteRearNouveauApplication",
        "request": "launch",
        "mainClass": "org.ieeervce.api.siterearnouveau.SiteRearNouveauApplication",
        "projectName": "site-rear-nouveau",
        "env": {
            "SPRING_PROFILES_ACTIVE": "local"
        }
    }

  • IntelliJ: Set the active profiles to local
• Start the project with SPRING_PROFILES_ACTIVE=local ./gradlew bootRun

Current Implementation Notes Hacks

• JWT and Basic auth supported