Skip to content

Commit

Permalink
docs: README 수정 (#225)
Browse files Browse the repository at this point in the history
* docs: ERD 추가

* refactor: cookie 옵션 production에서만 secure로 동작.

* docs: README 수정

데모링크 추가
아키텍처 이미지 변경
API 문서 추가
기술 아이콘 추가
도전적인 과제 워딩 수정

* chore: 회원가입시 5백만원이 충전된 상태로 시작
  • Loading branch information
nawhes authored Dec 6, 2021
1 parent fb559e9 commit 37b529b
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 10 deletions.
36 changes: 28 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,31 @@
# Boostock
<img src="https://img.shields.io/badge/-React-1f2229?style=flat&logo=React">&nbsp;<img src="https://img.shields.io/badge/-TypeScript-1f2229?style=flat&logo=TypeScript">&nbsp;<img src="https://img.shields.io/badge/-Express-90c541?style=flat&logo=Node.js">&nbsp;<img src="https://img.shields.io/badge/-ESLint-4B32C3?style=flat&logo=ESLint">&nbsp;<img src="https://img.shields.io/badge/-Prettier-1b2b34?style=flat&logo=Prettier">&nbsp;<img src="https://img.shields.io/badge/-Jest-99424f?style=flat&logo=Jest">&nbsp;<img src="https://img.shields.io/badge/-Ncloud-00e064?style=flat">

<img width=80px height=25px src="https://img.shields.io/badge/-React-1f2229?style=flat&logo=React">&nbsp;
<img width=100px height=25px src="https://img.shields.io/badge/-TypeScript-1f2229?style=flat&logo=TypeScript">&nbsp;
<img width=80px height=25px src="https://img.shields.io/badge/-Express-90c541?style=flat&logo=Node.js">&nbsp;
<img width=80px height=25px src="https://img.shields.io/badge/-ESLint-4B32C3?style=flat&logo=ESLint">&nbsp;
<img width=80px height=25px src="https://img.shields.io/badge/-Prettier-1b2b34?style=flat&logo=Prettier">&nbsp;
<img width=60px height=25px src="https://img.shields.io/badge/-Jest-99424f?style=flat&logo=Jest">&nbsp;
<img width=60px height=25px src="https://img.shields.io/badge/-Ncloud-00e064?style=flat">&nbsp;
<img width=80px height=25px src="https://img.shields.io/badge/-MySQL-105382?style=flat&logo=MySQL">&nbsp;
<img width=100px height=25px src="https://img.shields.io/badge/-MongoDB-109a82?style=flat&logo=MongoDB">&nbsp;

**당신을 위한 주식 거래 플랫폼 - Boostock**

## 데모링크

```
https://https://boostock.kro.kr/
```

## 🧑‍💻 참여자
|J008|J050|J089|J176|
|:-:|:-:|:-:|:-:|
|<img src="https://github.com/rnjsrntkd95.png" width="150px">|<img src="https://github.com/jaehyeon48.png" width="150px">|<img src="https://github.com/nawhes.png" width="150px">|<img src="https://github.com/SYN0P.png" width="150px">|
|[권구상](https://github.com/rnjsrntkd95)|[김재현](https://github.com/jaehyeon48)|[박세환](https://github.com/nawhes)|[장민준](https://github.com/SYN0P)|

## 💖 기획의도
| J008 | J050 | J089 | J176 |
| :----------------------------------------------------------: | :---------------------------------------------------------: | :-----------------------------------------------------: | :----------------------------------------------------: |
| <img src="https://github.com/rnjsrntkd95.png" width="150px"> | <img src="https://github.com/jaehyeon48.png" width="150px"> | <img src="https://github.com/nawhes.png" width="150px"> | <img src="https://github.com/SYN0P.png" width="150px"> |
| [권구상](https://github.com/rnjsrntkd95) | [김재현](https://github.com/jaehyeon48) | [박세환](https://github.com/nawhes) | [장민준](https://github.com/SYN0P) |

## 💖 기획의도

저희가 이 주제를 선택한 이유는 기술적으로 난이도가 있는 것을 경험하는 것을 목적으로, 많은 트래픽이 몰려도 장애가 발생하지 않고 데이터의 실시간 처리가 중요한 주식(혹은 코인과 같은) 트레이딩 시스템을 선택하게 되었습니다.

Expand All @@ -18,12 +34,16 @@
또한, 많은 사용자가 실제로 매매를 하는 것을 모방하기 위해 트레이딩 봇을 만들어서 실시간으로 거래를 요청하는 대량의 트래픽을 발생시킬 계획입니다.

## ⛳ 우리의 도전적인 과제

1. **[Front]** 지연을 최소화한 실시간 처리 형태로 서버와 통신, 표현
2. **[Back]** 분산 처리를 포함한 대량의 트래픽 처리
2. **[Back]** 분산 처리를 포함한 실시간 요청 트래픽 처리

## ⚙️ 시스템 아키텍처
![](https://i.imgur.com/4d16zqE.png)

![](https://github.com/boostcampwm-2021/web30-boostock/blob/develop/docs/boostock-architecture.jpg?raw=true)

## 💬 Project Planning

[📖 백로그](https://docs.google.com/spreadsheets/d/1A88FveAieMR75ogdRdZTzoVXXzJbeHkM-m7dv7uNmKk/edit#gid=0)
[🖥️ 와이어프레임](https://miro.com/app/board/o9J_ln2R7o4=/?invite_link_id=436446773268)
[📋 API문서](https://github.com/boostcampwm-2021/web30-boostock/wiki/API-%EB%AC%B8%EC%84%9C)
1 change: 1 addition & 0 deletions back/src/config/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ export default {
maxTransperMoney: 10000000,
maxPrice: 10000000000,
maxAmount: 10000,
cookieSecure: process.env.NODE_ENV === 'production',
};
2 changes: 1 addition & 1 deletion back/src/loaders/session.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ export default function session(): express.Application {
cookie: {
path: '/',
httpOnly: true,
secure: true,
secure: config.cookieSecure,
sameSite: 'strict',
maxAge: config.maxAge,
},
Expand Down
2 changes: 1 addition & 1 deletion back/src/services/UserService.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ export default class UserService {
return userRepository;
}

static async signUp({ username, email, socialGithub, balance = 0 }: IUserInfo): Promise<User> {
static async signUp({ username, email, socialGithub, balance = 5000000 }: IUserInfo): Promise<User> {
if (!checkEmail(email)) throw new ParamError(ParamErrorMessage.INVALID_PARAM);
const userRepository: UserRepository = getCustomRepository(UserRepository);
const user = userRepository.create({
Expand Down
Binary file added docs/erd.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 37b529b

Please sign in to comment.