Skip to content

Diego-Rocha/aurum-tech-eval

Repository files navigation

aurum-tech-eval

This project is mandatory as part of Aurum's recruitment and selection policy.

Original requirement

Console (Bash)

# Define your GCP Credentials (REQUIRED)
export GOOGLE_APPLICATION_CREDENTIALS=/path/to/your/gcp/credentials.json

# Build the app
> ./gradlew build

# Runs the app (avaliable at http://localhost:8080)
> ./gradlew bootRun

# Generates the jar
> ./gradlew bootJar

## EXTRAS ##
# Generates the code coverage report. ouput in:build/reports/jacoco/test/html/index.html
> ./gradlew jacocoTestReport

# Checks if code coverage is > 90% on packages 'controller, service, business and converter'
> ./gradlew jacocoTestCoverageVerification

Checklist

  • Working API (Required)
    • FR 1: save publications
    • FR 2: when type is HEARING then save on schedule
      • get date from classifiedDate
      • or parse date from clippingMatter
      • or plus 3 business days from clippingDate
    • FR 3: when is important then create alert
    • FR 4: delete one/all publications
    • FR 5: list the publications with pagination
    • FR 6: view a publication and mark then as viewed
    • FR 7: list alerts with pagination
    • FR 8: list commitments with pagination
  • Unit Tests (Required)
  • Deploy on Goggle App Engine Standard (25pts)
    • @TODO discover how to use
  • Quality code with Codebeat (GPA > 3 = 20pts)
    • Currently: codebeat badge
  • API Docs (20pts)
  • A Good Readme and Hosted on Github (10pts)

Package Structure

inside the main package 'io.diego.aurum.tech.eval' we have:

  • controller: spring rest controllers
  • service: spring services
  • repository: spring repositories
  • config: additional spring config
  • business: contain the main application logic
  • converter: convert logic between entity and dto
  • model: simple models like entity, dto and enums

Project TimeLine

  • Start: 2020-06-25
  • Deadline: 2020-07-02

Stack

  • Java
  • Spring Boot
  • Gradle
  • Google Cloud API
  • Lombok

About

This project is mandatory as part of Aurum's recruitment and selection policy.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages