readme.md

Starlite API v2

API that allows for searching for course details and generating schedules for the University of Hawai'i

Quickstart Guide

Gradle

gradle bootRun    # via Gradle

./gradlew bootRun # or via Gradle Wrapper

Jar

1. Build jar

gradle bootJar    # via Gradle

./gradlew bootJar # or via Gradle Wrapper

2. Run jar

java -jar ./build/libs/starlite-2.0.0.jar

Docker (Recommended)

1. Build image

docker build -t starlite-api:2.0.0 .

2. Run container

docker run --rm -p 8080:8080 starlite-api:2.0.0

Usage

API service is now available at http://localhost:8080/api/v2

API endpoint documentation can be found at API Endpoints.

• Get all Campuses
• Get all Terms
• Get all Subjects
• Get all Courses (Single Subject)
• Filter Courses (Single Subject)
• Get all Courses (Multiple Subjects)
• Filter Courses (Multiple Subjects)
• Generate Schedules

Insomnia documentation is also available here.