Skip to content

Commit 8d621b4

Browse files
committed
#S06P21S001-399 docs: 목차, ERD 추가
Former-commit-id: e9a7e515addec89833544dca81b4a49c556982a4
1 parent 5760a8e commit 8d621b4

2 files changed

Lines changed: 60 additions & 40 deletions

File tree

README.md

Lines changed: 60 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,30 @@
1-
# README
1+
## 목차
2+
3+
### 1. [Introduction](#motivation)
4+
5+
### 2. [Main Function](#main-function)
6+
7+
### 3. [Technical Features](#technical-features)
8+
9+
### 4. [Environment](#%EF%B8%8Fdevelopment-environment)
10+
11+
### 5. [Project Planning](#service-architecture)
12+
13+
### 6. [Our Team](#our-team)
14+
15+
### 7. [Challenges ( Problems / Bugs )](#challenges-problems-bugs-)
216

317
![Untitled](README_assets/Untitled.png)
418

5-
## 💡**기획의도**
19+
## 💡**Motivation**
620

721
최근 들어 주식에 대한 관심이 급증했으며 작년 동안 유입된 신규 투자자만 400만명에 다다릅니다.<br>그리고 이들은 주식에 대한 지식과 경험이 부족했고, 대부분 투자를 실패했습니다.
822

923
이는 안정적인 주식 투자를 위한 러닝 커브는 높고, 이를 학습할 플랫폼은 부족하기 때문입니다.
1024

1125
그래서 저희는 주식에 입문하며, 주식에 대해 잘 모르는 소액 투자자들 일명 개미, 주린이들이 <br>안전하고 효과적으로 주식 투자를 공부할 수 있도록 매매 전략을 학습하고, 직접 구성한 전략을 테스트할 수 있는 서비스를 개발했습니다.
1226

13-
## 💸**서비스 소개**
27+
## 💸**Introduction**
1428

1529
**내 집 마련을 위해 주식은 선택이 아닌 필수!!<br>
1630
남들 다하니까 시작했다가, 손해만 보고 그만 두신 적 없으신가요?!<br>
@@ -19,9 +33,11 @@
1933

2034
🔹**JRStock**은 국내 주식 기반 백테스트 플랫폼입니다.<br> **JRStock**은 주린이를 대상으로 서비스를 구성하여 누구나 쉽게 매매 전략을 구성하고, 테스트해볼 수 있으며, 결과를 분석할 수 있습니다. <br>또한 종목 토론방을 통해 지식을 공유하거나, 랭킹을 통해 다른 사람과 전략을 경쟁, 공유하며 성공적인 주식투자로 이끌 수 있습니다.
2135

22-
## 💻 **프로젝트 기간 - [2021.02.21 ~ 2021.04.08]**
36+
## 💻 **Project Period - [2021.02.21 ~ 2021.04.08]**
37+
38+
sddsad
2339

24-
## 👀 **JRStock 서비스 시연 화면**
40+
## 👀 **jrstock service demo**
2541

2642
### 백테스트 생성
2743

@@ -47,7 +63,7 @@
4763

4864
![태블릿알림.gif](README_assets/%ED%83%9C%EB%B8%94%EB%A6%BF%EC%95%8C%EB%A6%BC.gif)
4965

50-
## 💡**주요 기능**
66+
## 💡**Main Function**
5167

5268
### 회원 관리
5369

@@ -88,7 +104,31 @@
88104
- 일간, 주간, 월간 수익율 기준 전체 순위 정보 제공
89105
- 이름 검색을 통해 원하는 사용자 랭킹 정보를 제공
90106

91-
## ⚙️**개발 환경**
107+
## 💪**Technical Features**
108+
109+
### 주가 예측
110+
111+
주가 예측 서비스는 이전 주가 데이터를 통해 다음 주가를 예측하여 제공하는 서비스입니다.<br>
112+
주가 예측 서비스에는 딥러닝 기술 RNN이 적용 됐습니다.<br>
113+
기존 신경망 알고리즘은 데이터 맥락을 학습시킬 수 없었기 때문에 순환 신경망 알고리즘을 사용하게 됐습니다.<br> 아래 예시에서 주가 추세를 상당히 정확하게 예측하고 있습니다.
114+
115+
![Untitled](README_assets/Untitled%202.png)
116+
117+
### 백테스팅 빅데이터
118+
119+
약 2500개 주식에 대한 상장 이후 모든 일일 거래 데이터를 사용하고 있습니다. 또한 매일 스케쥴링을 통해 최신 데이터를 자동으로 수집하고 있습니다.
120+
121+
![빅데이터사진.png](README_assets/%EB%B9%85%EB%8D%B0%EC%9D%B4%ED%84%B0%EC%82%AC%EC%A7%84.png)
122+
123+
### 데이터 시각화
124+
125+
백테스트 결과를 한 눈에 알아보기 편하도록 차트를 사용하여 데이터를 시각화 하였습니다.
126+
127+
![종목라인차트.PNG](README_assets/%EC%A2%85%EB%AA%A9%EB%9D%BC%EC%9D%B8%EC%B0%A8%ED%8A%B8.png)
128+
129+
![연도별수익률차트.PNG](README_assets/%EC%97%B0%EB%8F%84%EB%B3%84%EC%88%98%EC%9D%B5%EB%A5%A0%EC%B0%A8%ED%8A%B8.png)
130+
131+
## ⚙️**Development Environment**
92132

93133
### Backend
94134

@@ -142,35 +182,7 @@
142182
- Google Analytics
143183
- Google Cloud Platform(OAuth)
144184

145-
## 💫서비스 아키텍처
146-
147-
![Untitled](README_assets/Untitled%201.png)
148-
149-
## 💪**기술 특이점**
150-
151-
### 주가 예측
152-
153-
주가 예측 서비스는 이전 주가 데이터를 통해 다음 주가를 예측하여 제공하는 서비스입니다.<br>
154-
주가 예측 서비스에는 딥러닝 기술 RNN이 적용 됐습니다.<br>
155-
기존 신경망 알고리즘은 데이터 맥락을 학습시킬 수 없었기 때문에 순환 신경망 알고리즘을 사용하게 됐습니다.<br> 아래 예시에서 주가 추세를 상당히 정확하게 예측하고 있습니다.
156-
157-
![Untitled](README_assets/Untitled%202.png)
158-
159-
### 백테스팅 빅데이터
160-
161-
약 2500개 주식에 대한 상장 이후 모든 일일 거래 데이터를 사용하고 있습니다. 또한 매일 스케쥴링을 통해 최신 데이터를 자동으로 수집하고 있습니다.
162-
163-
![빅데이터사진.png](README_assets/%EB%B9%85%EB%8D%B0%EC%9D%B4%ED%84%B0%EC%82%AC%EC%A7%84.png)
164-
165-
### 데이터 시각화
166-
167-
백테스트 결과를 한 눈에 알아보기 편하도록 차트를 사용하여 데이터를 시각화 하였습니다.
168-
169-
![종목라인차트.PNG](README_assets/%EC%A2%85%EB%AA%A9%EB%9D%BC%EC%9D%B8%EC%B0%A8%ED%8A%B8.png)
170-
171-
![연도별수익률차트.PNG](README_assets/%EC%97%B0%EB%8F%84%EB%B3%84%EC%88%98%EC%9D%B5%EB%A5%A0%EC%B0%A8%ED%8A%B8.png)
172-
173-
## 🔨**협업 툴**
185+
## 🔨**Collaboration Tools**
174186

175187
- Gitlab
176188
- Jira
@@ -181,19 +193,27 @@
181193
- Figma
182194
- ERDCloud
183195

184-
## 📜**기능 명세서**
196+
## 💫Service Architecture
197+
198+
![Untitled](README_assets/Untitled%201.png)
199+
200+
## 📜**Functional Specification**
185201

186202
[JRStock 기능명세서.pdf](README_assets/JRStock_%EA%B8%B0%EB%8A%A5%EB%AA%85%EC%84%B8%EC%84%9C.pdf)
187203

188-
## 🖼️**화면 설계서 (초안)**
204+
## 🖼️**Figma Wireframe**
189205

190206
![화면설계서_초안2.png](README_assets/%ED%99%94%EB%A9%B4%EC%84%A4%EA%B3%84%EC%84%9C_%EC%B4%88%EC%95%882.png)
191207

192-
## 👨‍💻**팀원 소개 / 역할**
208+
## 🔗**ERD**
209+
210+
![ERD.png](README_assets/JRStock_ERD.png)
211+
212+
## 👨‍💻**Our Team**
193213

194214
![Untitled](README_assets/Untitled%203.png)
195215

196-
## 🐞**힘들었던 점 ( 문제 / 버그 )**
216+
## 🐞**Challenges ( Problems / Bugs )**
197217

198218
### BE
199219

README_assets/JRStock_ERD.png

553 KB
Loading

0 commit comments

Comments
 (0)