README.md

Overview

This is a fictional Stock Trading API project.

What's a trade?

A trade represents the Buying or Selling of a Stock. A trade includes the following properties:

• symbol (e.g. 'AAPL' for Apple)
• quantity
• side (buy or sell)
• price
• status (SUBMITTED, CANCELLED, COMPLETED, or FAILED)

Building the project

./gradlew clean build

Running the project

./gradlew bootRun

Generating docs

./gradlew asciidoc