|
10 | 10 |
|
11 | 11 | ## TEAM 🔥FIRE🔥 소개
|
12 | 12 |
|
13 |
| -|윤영기 : FE|고주형 : BE|이하령 : FE| |
14 |
| -|:--:|:--:|:---:| |
15 |
| -|<img width="160px" src="https://avatars.githubusercontent.com/u/66371206?v=4"> | <img width="160px" src="https://user-images.githubusercontent.com/64428916/195526068-33be2cd0-066c-4584-9ae9-8c3344a60fb9.jpg" /> | <img width="160px" src="https://avatars.githubusercontent.com/u/64428916?v=4"> | |
16 |
| -|[@071yoon](https://github.com/071yoon)|[@IamGroooooot](https://github.com/IamGroooooot)|[@halang](https://github.com/haryung-lee)| |
17 |
| -| [](https://wakatime.com/badge/user/4292264a-e9dd-4cc1-8ab6-1ada6ddb177a/project/79b7e168-b8e8-41f9-a790-c41967365f78) |[](https://wakatime.com/badge/user/95486c3b-017e-41e8-8d9c-20de1b876bf5/project/dabe2a55-4c66-49ab-ae59-8eba6b898e6f)|[](https://wakatime.com/badge/user/02d79381-005e-489b-b7f0-5fdf9dc2a088/project/d5dd888b-da07-4723-bc9d-f7c07c44307a)| |
| 13 | +| 윤영기 : FE | 고주형 : BE | 이하령 : FE | |
| 14 | +| :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | |
| 15 | +| <img width="160px" src="https://avatars.githubusercontent.com/u/66371206?v=4"> | <img width="160px" src="https://user-images.githubusercontent.com/64428916/195526068-33be2cd0-066c-4584-9ae9-8c3344a60fb9.jpg" /> | <img width="160px" src="https://avatars.githubusercontent.com/u/64428916?v=4"> | |
| 16 | +| [@071yoon](https://github.com/071yoon) | [@IamGroooooot](https://github.com/IamGroooooot) | [@halang](https://github.com/haryung-lee) | |
| 17 | +| [](https://wakatime.com/badge/user/4292264a-e9dd-4cc1-8ab6-1ada6ddb177a/project/79b7e168-b8e8-41f9-a790-c41967365f78) | [](https://wakatime.com/badge/user/95486c3b-017e-41e8-8d9c-20de1b876bf5/project/dabe2a55-4c66-49ab-ae59-8eba6b898e6f) | [](https://wakatime.com/badge/user/02d79381-005e-489b-b7f0-5fdf9dc2a088/project/d5dd888b-da07-4723-bc9d-f7c07c44307a) | |
18 | 18 |
|
19 | 19 | ## 프로젝트 소개
|
20 | 20 |
|
21 | 21 | **모도코**(모여서 도란도란 코딩) 프로젝트는 모각코를 하고 싶은 사람들이 모여 도란도란 코딩할 수 있게 해주는 플랫폼입니다. 개발자 친화적인 기능을 갖추고 모각코로 만들어진 인연이 이어질 수 있게 만들고자 합니다.
|
22 | 22 |
|
| 23 | +--- |
| 24 | + |
| 25 | +## 실행방법 |
| 26 | + |
| 27 | +### Project Setting |
| 28 | + |
| 29 | +환경변수 세팅 |
| 30 | + |
| 31 | +```shell |
| 32 | +# ************************************************* # |
| 33 | +# This is an example env file for modoco frontend # |
| 34 | +# ************************************************* # |
| 35 | + |
| 36 | +# backend server |
| 37 | +REACT_APP_BASE_URL=your_backend_server |
| 38 | + |
| 39 | +# channel talk key |
| 40 | +REACT_APP_CHANNEL_IO_KEY=your_channel_talk_key |
| 41 | + |
| 42 | +# oauth |
| 43 | +# oauth client id |
| 44 | +REACT_APP_GITHUB_CLIENT_ID=your_github_oauth_client_id |
| 45 | +REACT_APP_KAKAO_CLIENT_ID=your_kakao_oauth_client_id |
| 46 | +REACT_APP_GOOGLE_CLIENT_ID=your_google_oauth_client_id |
| 47 | +# oauth redirect uri |
| 48 | +REACT_APP_KAKAO_REDIRECT_URI=your_kakao_redirect_uri |
| 49 | +REACT_APP_GOOGLE_REDIRECT_URI=your_google_redirect_uri |
| 50 | + |
| 51 | +# turn server |
| 52 | +REACT_APP_TURN_URL=your_turn_server_url |
| 53 | +REACT_APP_TURN_CREDENTIAL=your_turn_server_credential |
| 54 | +REACT_APP_TURN_USERNAME=your_turn_server_username |
| 55 | + |
| 56 | +# lambda server |
| 57 | +REACT_APP_LAMBDA_INVITE=your_lambda_server_url |
| 58 | +``` |
| 59 | + |
| 60 | +### Installation |
| 61 | + |
| 62 | +#### 1. Install npm dependency |
| 63 | + |
| 64 | +```shell |
| 65 | +# install packages |
| 66 | +$ yarn install |
| 67 | + |
| 68 | +# clean install packages |
| 69 | +$ yarn ci |
| 70 | +``` |
| 71 | + |
| 72 | +#### 2. Run React |
| 73 | + |
| 74 | +```shell |
| 75 | +# run app |
| 76 | +yarn start |
| 77 | + |
| 78 | +# run app in https |
| 79 | +# need SSL_CRT_FILE=cert.pem SSL_KEY_FILE=key.pem in root |
| 80 | +yarn start:https |
| 81 | + |
| 82 | +# check style lint |
| 83 | +yarn lint:css |
| 84 | +``` |
| 85 | + |
| 86 | +### Build |
| 87 | + |
| 88 | +```shell |
| 89 | +# build app |
| 90 | +yarn build |
| 91 | +``` |
| 92 | + |
| 93 | +### Testing |
| 94 | + |
| 95 | +```shell |
| 96 | +# start test mode |
| 97 | +yarn test |
| 98 | + |
| 99 | +# run app and open cypress |
| 100 | +yarn cypress |
| 101 | + |
| 102 | +# open cypress without opening app |
| 103 | +npx cypress open |
| 104 | +``` |
| 105 | + |
| 106 | +--- |
| 107 | + |
23 | 108 | ## Stacks 🚀
|
24 | 109 |
|
25 | 110 | ### Environment
|
|
50 | 135 |
|
51 | 136 |   
|
52 | 137 |
|
| 138 | +--- |
| 139 | + |
53 | 140 | ## 동작 화면 💻
|
54 | 141 |
|
55 | 142 | ### 화면 구성
|
|
66 | 153 | | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------: |
|
67 | 154 | | 바다 | 캠핑 | 모닥불 | 우주 | 여행 |
|
68 | 155 |
|
| 156 | +--- |
| 157 | + |
69 | 158 | ## 주요 기능 ✨
|
70 | 159 |
|
71 | 160 | ### ⭐️ 진행중인 모각코 방에 입장
|
|
93 | 182 | - 얼마나 했는지 궁금하시다면, 통계 페이지를 참고하세요
|
94 | 183 | - 오늘, 이번주, 한달 등 다양한 통계 자료를 보여드려요
|
95 | 184 |
|
| 185 | +--- |
| 186 | + |
96 | 187 | ## 아키텍쳐 ⚒
|
97 | 188 |
|
98 | 189 | ### Full Architecture
|
|
107 | 198 |
|
108 | 199 | 
|
109 | 200 |
|
| 201 | +--- |
| 202 | + |
110 | 203 | ## 개발로그 ✏️
|
111 | 204 |
|
112 | 205 | <details>
|
|
128 | 221 |
|
129 | 222 | [](https://velog.io/@071yoon/React%EB%A1%9C-%EC%98%A4%EB%94%94%EC%98%A4-%EB%B9%84%EC%A3%BC%EC%96%BC%EB%9D%BC%EC%9D%B4%EC%A0%80-%EB%A7%8C%EB%93%A4%EA%B8%B0)
|
130 | 223 |
|
131 |
| -[]( |
132 |
| -https://velog.io/@071yoon/Cypress%EB%A1%9C-e2e-%ED%85%8C%EC%8A%A4%ED%8A%B8-%EC%A7%84%ED%96%89%ED%95%98%EA%B8%B0) |
| 224 | +[](https://velog.io/@071yoon/Cypress%EB%A1%9C-e2e-%ED%85%8C%EC%8A%A4%ED%8A%B8-%EC%A7%84%ED%96%89%ED%95%98%EA%B8%B0) |
133 | 225 |
|
134 |
| -[]( |
135 |
| -https://velog.io/@071yoon/APM-%EB%A1%9C%EA%B7%B8%EB%A1%9C-%EB%AC%B8%EC%A0%9C-%ED%95%B4%EA%B2%B0%ED%95%98%EA%B8%B0) |
| 226 | +[](https://velog.io/@071yoon/APM-%EB%A1%9C%EA%B7%B8%EB%A1%9C-%EB%AC%B8%EC%A0%9C-%ED%95%B4%EA%B2%B0%ED%95%98%EA%B8%B0) |
136 | 227 |
|
137 | 228 | </details>
|
138 | 229 |
|
|
0 commit comments