seanoh

update README

Showing 1 changed file with 252 additions and 0 deletions
1 +<div id="top"></div>
2 +<!--
3 +*** Thanks for checking out the Best-README-Template. If you have a suggestion
4 +*** that would make this better, please fork the repo and create a pull request
5 +*** or simply open an issue with the tag "enhancement".
6 +*** Don't forget to give the project a star!
7 +*** Thanks again! Now go create something AMAZING! :D
8 +-->
9 +
10 +
11 +
12 +<!-- PROJECT SHIELDS -->
13 +<!--
14 +*** I'm using markdown "reference style" links for readability.
15 +*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
16 +*** See the bottom of this document for the declaration of the reference variables
17 +*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
18 +*** https://www.markdownguide.org/basic-syntax/#reference-style-links
19 +-->
20 +
21 +<!-- PROJECT LOGO -->
22 +<br />
23 +<div align="center">
24 + <a href="http://khuhub.khu.ac.kr/2019102198/Tunnel.git">
25 + <img src="https://images.christiantoday.co.kr/data/images/full/332493/image.jpg" alt="Logo" width="50%" height="50%">
26 + </a>
27 +
28 +<h1 align="center">익명 고민상담 서비스</h1>
29 +</div>
30 +
31 +
32 +
33 +<!-- TABLE OF CONTENTS -->
34 +<br>
35 + <h3>목차</h3>
36 + <ol>
37 + <li>
38 + <a href="#about-the-project">About The Project</a>
39 + <ul>
40 + <li><a href="#built-with">Built With</a></li>
41 + </ul>
42 + </li>
43 + <li>
44 + <a href="#getting-started">Getting Started</a>
45 + <ul>
46 + <li><a href="#installation">Installation</a></li>
47 + <li><a href="#prerequisites">Prerequisites</a></li>
48 + </ul>
49 + </li>
50 + <li><a href="#DB Schema">DB Schema</a></li>
51 + <li><a href="#usage">Usage</a></li>
52 + <li><a href="#roadmap">Roadmap</a></li>
53 + <li><a href="#contributing">Contributing</a></li>
54 + <li><a href="#license">License</a></li>
55 + <li><a href="#contact">Contact</a></li>
56 + </ol>
57 +</br>
58 +
59 +
60 +
61 +<!-- ABOUT THE PROJECT -->
62 +## About The Project
63 +
64 +> 터널과 같이 앞길이 깜깜한 인생 고민, mbti와 아이디 비밀번호만 입력하면 익명의 사용자들에게 고민 상담을 받을 수 있습니다!
65 +
66 +
67 +<p align="right">(<a href="#top">back to top</a>)</p>
68 +
69 +
70 +
71 +### Built With
72 +
73 +> * [React.js](https://reactjs.org/) -- front end
74 +> * [Node.js](https://nodejs.org/) -- back end
75 +> * [MySQL](https://www.mysql.com/) -- database
76 +> * [AWS](https://aws.amazon.com/) -- server
77 +
78 +
79 +<p align="right">(<a href="#top">back to top</a>)</p>
80 +
81 +
82 +
83 +<!-- GETTING STARTED -->
84 +## Getting Started
85 +
86 +* Install
87 +
88 +> 1. Git
89 +> 2. Node JS
90 +> 3. MySQL
91 +
92 +### Installation
93 +
94 +* 1. Clone repository
95 + ```sh
96 + git clone http://khuhub.khu.ac.kr/2019102198/Tunnel.git
97 + ```
98 +
99 +
100 +* 2. Install NPM packages
101 + ```sh
102 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel> cd tunnel_BE
103 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE> cd server
104 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE\server> npm install
105 + ```
106 + ```sh
107 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE\server> cd ..
108 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE> cd..
109 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel> cd turnel_FE
110 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\turnel_FE> npm install
111 + ```
112 +
113 +<p align="right">(<a href="#top">back to top</a>)</p>
114 +
115 +### Prerequisites
116 +* Login MySQL / Create database
117 + ```sh
118 + 윈도우 + R ---> cmd 실행창 열기
119 + ```
120 + ```sh
121 + C:\Users\seano>cd..
122 + C:\Users>cd..
123 + C:\>cd "Program Files"
124 + C:\Program Files>cd MySQL
125 + C:\Program Files\MySQL>cd "MySQL Server 8.0"
126 + C:\Program Files\MySQL\MySQL Server 8.0>cd bin
127 + C:\Program Files\MySQL\MySQL Server 8.0\bin>mysql -h localhost -u root -p
128 + Enter password: **********
129 + Welcome to the MySQL monitor. Commands end with ; or \g.
130 + Your MySQL connection id is 27
131 + Server version: 8.0.19 MySQL Community Server - GPL
132 +
133 + Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
134 +
135 + Oracle is a registered trademark of Oracle Corporation and/or its
136 + affiliates. Other names may be trademarks of their respective
137 + owners.
138 +
139 + Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
140 +
141 + mysql> CREATE SCHEMA tunnel DEFAULT CHARACTER SET utf8;
142 + Query OK, 1 row affected, 1 warning (0.04 sec)
143 + ```
144 +* AWS 서버 설정
145 + ```sh
146 +
147 + ```
148 +
149 +## DB Schema
150 +* users 사용자: utf-8
151 +
152 + |Column|Type|Information|
153 + |---|---|---|
154 + |id|int|key, 자동생성|
155 + |name|string|User가 작성한 Id|
156 + |pw|string||
157 + |mbti|CHAR(4)|16가지중 1개만 저장|
158 + |update|Bool|업데이트 여부(새 고민도착, 새 댓글 도착 여부)|
159 +
160 +* posts 게시글: utf-8
161 +
162 + |Column|Type|Information|
163 + |---|---|---|
164 + |id|int|key, 자동생성|
165 + |userid|string|foreign key (users.name) / 부모 삭제시 삭제|
166 + |post|text|게시글|
167 + |title|text|제목|
168 + |update|Bool|업데이트 여부(새 댓글 작성 여부)|
169 + |created_at|time|작성시간|
170 +
171 +* comment 댓글: utf-8
172 +
173 + |Column|Type|Information|
174 + |---|---|---|
175 + |id|int|key, 자동생성|
176 + |postid|int||
177 + |userid|text|foreign key (users.id) / 부모 삭제시 삭제|
178 + |comment|text|댓글 정보|
179 + |created_at|time|작성시간|
180 +
181 +<!-- USAGE EXAMPLES -->
182 +## Usage
183 +> ### 용도 설명
184 +
185 +> #### 1. Login Page
186 +> - http://localhost:3000/login
187 +<img src="images/login.png" alt="Logo" width="100%" height="100%">
188 +
189 +> #### 2. Register Page
190 +> - http://localhost:3000/register
191 +<img src="images/register.png" alt="Logo" width="100%" height="100%">
192 +
193 +> #### 3. User board Page
194 +> - http://localhost:3000/main
195 +<img src="images/board.png" alt="Logo" width="100%" height="100%">
196 +
197 +<p align="right">(<a href="#top">back to top</a>)</p>
198 +
199 +
200 +<!-- ROADMAP -->
201 +## Roadmap
202 +
203 +> - 회원가입 기능 구현 (Id, mbti, password, password 재확인 입력)
204 +> - 중복된 Id 유무 확인, 중복시 재입력 요구
205 +> - password, password 재확인 일치 여부 확인
206 +> - 모든 문제 없다면, 회원정보 DB에 저장, 로그인 화면 이동
207 +> - 로그인 기능 구현
208 +> - Id/Password 받아서 회원정보 DB에 Id로 탐색 후 Password 일치 여부 확인
209 +> - 모든 문제 없다면, 게시판 화면 이동
210 +> - 사용자 게시판 구현
211 +> - 내 계정정보, mbti 표시
212 +> - 내 게시글 시간순으로 나열
213 +> - 게시글 밑에 댓글 수 표시
214 +
215 +<p align="right">(<a href="#top">back to top</a>)</p>
216 +
217 +
218 +
219 +<!-- CONTRIBUTING -->
220 +## Contributing
221 +
222 +게시판에 아이디어를 추가하고 싶다면...
223 +
224 +> 1. Fork the Project
225 +> 2. Create your Feature Branch (`git checkout -b feature/"추가된 아이디어 이름"`)
226 +> 3. Commit your Changes (`git commit -m 'Added features`)
227 +> 4. Push to the Branch (`git push origin feature/"추가된 아이디어 이름"`)
228 +> 5. Open a Pull Request
229 +
230 +<p align="right">(<a href="#top">back to top</a>)</p>
231 +
232 +
233 +
234 +<!-- LICENSE -->
235 +## License
236 +
237 +Distributed under the [MIT License](License).
238 +
239 +<p align="right">(<a href="#top">back to top</a>)</p>
240 +
241 +
242 +
243 +<!-- CONTACT -->
244 +## Contact
245 +
246 +> - 오인제 (seanoh@khu.ac.kr)
247 +> - 정의왕 (wang323@khu.ac.kr)
248 +> - 고병후 (gobyeonghu@ khu.ac.kr)
249 +
250 +Project Link: [http://khuhub.khu.ac.kr/2019102198/Tunnel.git](http://khuhub.khu.ac.kr/2019102198/Tunnel.git)
251 +
252 +<p align="right">(<a href="#top">back to top</a>)</p>
...\ No newline at end of file ...\ No newline at end of file