README.md

StoComm

A platform where investors can share their insights to community via real-time voice chat and collaborative whiteboard tool.
Inspired by Tradingview and Stocktwits.

• Home page
• Ideas Explore page

How To Start App

1. install docker
2. go with docker compose up, it handles the database migrate.

Test Account

• Email: [email protected]
• Password: test

Vistors are only for ideas posts reviewing.
Please log in to experience complete collaborative features!

One-Click Login

Quick fill out login form with demo email and password

• Fast-Login

---

Home Page

Table of Contents

• Features
• Technologies
• Architecture
• Socket Flowchart
• Database Schema
• Main Features
• Contact

Features

• Start a room to discuss or share insights

  • Host can choose a stock as a topic by entering a company name or stock code

  • Host can add multiple analytic charts to the whiteboard

  • Clients can share or discuss ideas with room member related to the topic after joining a room

• Drawing & Voice permission Control

  • Host View

    • Hosts can control below permissions when a focused environment is needed

      • Client's drawing permission

      • Client's voice permission

  

  • Client View

    • The drawing tool is hidden when Host turn off drawing permission

    • The voice connection is closed when Host mutes all clients, which remains only one-way broadcast

  

• Discuss topics with real-time collaborative drawing tool

• Post your idea to community

---

Architecture

---

Database Schema

---

Technologies

Back-End

• Runtime: Node.js
• Framework: Express
• Server OS: Linux
• Server-side Render: Handlebars

Front-End

• Framework: Bootstrap
• Chart Library: Anycahrt
• Drawing Library: Konva

WebSocket

• Socket.IO

WebRTC

• PeerJS

Cloud Service (AWS)

• EC2
• S3 + CloudFront
• RDS

Database

• MySQL
• Redis

Networking

• Nginx

Test

• Jest
• Supertest

Others

• Design Pattern: MVC
• Linter: Prettier

Contact

• LinkedIn
• Email: [email protected]