Simple Stock Market

Table of Contents

1. Running the Application
   • Using IntelliJ
   • Using the Jar File
2. Commands
3. Examples
   • Adding Stocks
   • Calculating Dividend Yield
   • Calculating P/E Ratio
   • Capturing Trades
   • Calculating Volume Weighted Stock Price
   • Calculating All Share Index
   • Displaying Stocks
   • Displaying Trades
   • Removing Stocks
4. Testing

Running the application

Using IntelliJ

Simply right click on SimpleStockMarketApplication.kt and select run Run 'SimpleStockMarketApplication.kt'.

Using a Jar file

There is an executable .jar in the root of the project. Enter java -jar simple-stock-market.jar to run the application.

Commands

• add: Add a Stock
  • add <STOCK_IDENTIFIER> <ORDINARY|PREFERRED> <LAST_DIVIDEND> <PAR_VALUE>
• calculate-dividend-yield: Calculate the dividend yield for a given Stock
  • calculate-dividend-yield <STOCK_IDENTIFIER> <PRICE>
• calculate-pe-ratio: Calculate the Price to Earnings Ratio for a given Stock
  • calculate-pe-ratio <STOCK_IDENTIFIER> <PRICE>
• capture-trade: Capture a Trade
  • capture-trade <STOCK_IDENTIFIER> <BUY|SELL> <QUANTITY> <TRADED_PRICE>
• calculate-vwap: Calculate the Volume Weighted Stock Price based on trades in past 15 minutes
• calculate-all-share-index: Calculate the all Share Index for all Stocks
• display-stocks: Displays all Stocks
• display-trades: Displays all Trades, grouped by Stock
• remove: Remove a Stock
  • remove <STOCK_IDENTIFIER>

Examples

Adding a Stock

add CAR ORDINARY 34.55 10
add TAT PREFERRED 22.78 120 8.9

Calculating Dividend Yield

calculate-dividend-yield CAR 10.50

Calculating P/E Ratio

calculate-pe-ratio CAR 15.77

Capturing Trades

capture-trade CAR BUY 50 19.22

Calculating Volume Weighted Stock Price

calculate-vwap

Calculating All Share Index

calculate-all-share-index

Displaying Stocks

display-stocks

Displaying Trades

display-trades

Removing a Stock

remove CAR

Testing

To run the tests, enter ./gradlew clean test.