https://github.com/fynnfluegge/stonks-platform-ng-kt

Kotlin/Angular Realtime Stock Monitor
https://github.com/fynnfluegge/stonks-platform-ng-kt

angular apexcharts docker github-actions google-cloud-platform kotlin reactive-streams reactor spring-boot stock-market typescript

Last synced: 17 days ago
JSON representation

Kotlin/Angular Realtime Stock Monitor

• Host: GitHub
• URL: https://github.com/fynnfluegge/stonks-platform-ng-kt
• Owner: fynnfluegge
• Created: 2020-08-16T13:43:34.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2022-08-08T08:55:11.000Z (over 2 years ago)
• Last Synced: 2024-10-11T18:13:42.958Z (about 1 month ago)
• Topics: angular, apexcharts, docker, github-actions, google-cloud-platform, kotlin, reactive-streams, reactor, spring-boot, stock-market, typescript
• Language: TypeScript
• Homepage:
• Size: 1.69 MB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
 Welcome to the Stonk-Platform 


 Technology Stack 



	

  	

  	 

  	

  	  

  	

  	

  	



#

[Live-Demo](http://47.91.78.219:3000)

#

![](doc/list-view.png)

![](doc/cards-view.png)

![](doc/heatmap.png)

---

## How To Run

### Run on local machine with docker

Install docker.

Build the api service with ```mvn clean install```

in api directory.  

Build the web app with ```ng build --prod```

in web directory.  

Create Docker images with ```docker-compose``` in project root.  

Create docker containers and run them with ```docker run```.

### Run on local machine in debug mode

Start api service by run ```StonkMonitorApp```. Start web app with ```ng serve``` in the web directory.

## API Specification

```

/quote/{symbol}

```

**GET** single quote symbol data  

**Param**: ```symbol=[alphanumeric]```

---

```

/stream/quotes/{industry}

```  

**GET** stream of all industry specific quotes  

**Param:** ```industries:[INDICES, TECH, HEALTH, INDUSTRIAL, MEDIA, MOBILITY,

FINANCE, FOOD, RETAIL, ENERGY]```

---

```

/stream/quotes/{industry}/{category}

```  

**GET** stream of subindustry quotes  

**Param**: ```categories:[ETF, FANG, MANUFACTURING, SEMICONDUCTOR, ECOMMERCE,

SOFTWARE, CLOUD, SAAS, SECURITY, FOOD, GASTRONOMY, MATERIALS,

CHEMICALS, TELECOMMUNICATION, REALESTATE, PHARMA, MEDTECH, BIOTECH,

DELIVERY, APPAREL, SPORTS, CONVENTIONAL, RENEWABLE, AKKU, AEROSPACE,

TRAVEL, AUTOMOBILE, PAYMENT, BANK, EXCHANGE, RENTAL, RECYCLING,

GAMES, TELEVISION, MUSIC, CHINA, CONSUMER, SERVICES, OTHER,

SHIPPING]```

---

```

/stream/quotes/{industry}/{page}

```   

**GET** stream of industry quotes with paging  

**Param**: ```page=[integer]```

---

```

/stream/quotes/{industry}/{page}?{sortProperty}&{sortDirection}

```

**GET** stream of sorted industry quotes with paging:  

**Param**: ```sortProperties:=[name, dayChangePercent, fiftyDayAverageChangePercent,

twoHundredDayAverageChangePercent, fiftyTwoWeekLowChangePercent, fiftyTwoWeekHighChangePercent, marketCap]```  

**Param**: ```sortDirection:[ascending, descending]```