docs : README.md demo

[kimhanui]

README.md 작성을 위한 사전 템플릿 정의, 내용 채워넣기

리마인드

폴더

• 폴더명 네이밍 (_)
• db계정: 프로젝트용 따로 팠는지?
• 폴더 이동: api-gateway, service discovery
• root쪽으로 빼놓기: db schema, error code

코드

• 정말 필요한 로그만 적기
• main(booup)시작 점은 코드가 짧아야 됨

깃브랜치

• 미사용 브랜치 제거

---

Playground

(프로젝트 소개, 개요)
(팀원 소개, 개발 파트, 소스 위치)

디렉토리 구조 ‼필요 없는 디렉토리 삭제‼

.
ㄴ bin 
ㄴ config
ㄴ data
ㄴ deploy
ㄴ docs
ㄴ resources
ㄴ scripts
ㄴ src
    ㄴ config (필요 없으면 삭제)
    ㄴ frontend
    ㄴ ios
    ㄴ library (필요 없으면 삭제)
    ㄴ server

실행화면

클라이언트 (iOS)

메인페이지	비디오 플레이어	친구와 영상 같이 시청하기

실시간 스트리밍 생성	실시간 스트리밍 시청	실시간 채팅	상단 고정 채팅

회원가입	마이페이지

클라이언트 (frontend)

로그인

메인페이지 / 비디오 재생

반응형 메인 레이아웃

회원가입 페이지	마이페이지

실시간 스트리밍 생성	실시간 스트리밍 시청

친구와 함께 시청

기술 스택

클라이언트 (iOS)

클라이언트 (frontend)

디자인

서버 (api)

서버 (infra)

• spring cloud gateway
• Eureka service discovery

아키텍처

ERD

프로젝트 실행

클라이언트 (iOS)

클라이언트 (frontend)

1. src/frontend 폴더에서 npm install 실행
2. src/frontend 폴더에서 .env 파일 생성 후 아래 내용 복사 후 붙여넣기

REACT_APP_API = https://dev.streaminggate.shop

REACT_APP_LIVE_SOCKET = wss://streaminggate.shop:4443

REACT_APP_USER_STATUS_API = http://3.37.201.189:9999

REACT_APP_USER_STATUS_SOCKET = http://3.37.201.189:9999/ws

REACT_APP_CHAT_API = http://3.38.16.211:8888

REACT_APP_CHAT_SOCKET = http://3.38.16.211:8888/ws

REACT_APP_UPLOAD_SERVICE = http://3.39.44.188:50006

REACT_APP_PROFILE_IMAGE = https://sgs-playground.s3.us-east-2.amazonaws.com/profiles/

3. npm run start로 실행

서버 (docker-compose 사용)

docker-compose 로 서버 실행

$ cd config
$ docker-compose up -d

❗ window라면 ffmpeg 설치후 코드 수정필요

• ffmpeg 다운로드: https://ffmpeg.org/download.html
• src/server/upload-service/src/main/resources/application.yml 수정:
  ffmpeg:path, ffprobbe:path 값을 다운로드 받은 실행 파일 위치로 수정