seanoh

add incomplete README

Showing 1 changed file with 207 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="#usage">Usage</a></li>
51 + <li><a href="#roadmap">Roadmap</a></li>
52 + <li><a href="#contributing">Contributing</a></li>
53 + <li><a href="#license">License</a></li>
54 + <li><a href="#contact">Contact</a></li>
55 + </ol>
56 +</br>
57 +
58 +
59 +
60 +<!-- ABOUT THE PROJECT -->
61 +## About The Project
62 +
63 +> 터널과 같이 앞길이 깜깜한 인생 고민, mbti와 아이디 비밀번호만 입력하면 익명의 사용자들에게 고민 상담을 받을 수 있습니다!
64 +
65 +
66 +<p align="right">(<a href="#top">back to top</a>)</p>
67 +
68 +
69 +
70 +### Built With
71 +
72 +> * [React.js](https://reactjs.org/) -- front end
73 +> * [Node.js](https://nodejs.org/) -- back end
74 +> * [MySQL](https://www.mysql.com/) -- database
75 +> * [AWS](https://aws.amazon.com/) -- server
76 +
77 +
78 +<p align="right">(<a href="#top">back to top</a>)</p>
79 +
80 +
81 +
82 +<!-- GETTING STARTED -->
83 +## Getting Started
84 +
85 +* Install
86 +
87 +> 1. Git
88 +> 2. Node JS
89 +> 3. MySQL
90 +
91 +### Installation
92 +
93 +1. Clone repository
94 + ```sh
95 + git clone http://khuhub.khu.ac.kr/2019102198/Tunnel.git
96 + ```
97 +2. Install NPM packages
98 + ```sh
99 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel> cd tunnel_BE
100 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE> cd server
101 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE\server> npm install
102 + ```
103 + ```sh
104 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE\server> cd ..
105 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE> cd..
106 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel> cd turnel_FE
107 + PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\turnel_FE> npm install
108 + ```
109 +
110 +<p align="right">(<a href="#top">back to top</a>)</p>
111 +
112 +### Prerequisites
113 +* Login MySQL / Create database
114 + ```sh
115 + 윈도우 + R ---> cmd 실행창 열기
116 + ```
117 + ```sh
118 + C:\Users\seano>cd..
119 + C:\Users>cd..
120 + C:\>cd "Program Files"
121 + C:\Program Files>cd MySQL
122 + C:\Program Files\MySQL>cd "MySQL Server 8.0"
123 + C:\Program Files\MySQL\MySQL Server 8.0>cd bin
124 + C:\Program Files\MySQL\MySQL Server 8.0\bin>mysql -h localhost -u root -p
125 + Enter password: **********
126 + Welcome to the MySQL monitor. Commands end with ; or \g.
127 + Your MySQL connection id is 27
128 + Server version: 8.0.19 MySQL Community Server - GPL
129 +
130 + Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
131 +
132 + Oracle is a registered trademark of Oracle Corporation and/or its
133 + affiliates. Other names may be trademarks of their respective
134 + owners.
135 +
136 + Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
137 +
138 + mysql> CREATE SCHEMA tunnel DEFAULT CHARACTER SET utf8;
139 + Query OK, 1 row affected, 1 warning (0.04 sec)
140 + ```
141 +* 내용
142 + ```sh
143 + 내용
144 + ```
145 +
146 +<!-- USAGE EXAMPLES -->
147 +## Usage
148 +> ### 용도 설명
149 +
150 +> #### 1. Login Page
151 +<img src="images/login.png" alt="Logo" width="100%" height="100%">
152 +
153 +> #### 2. Register Page
154 +<img src="images/register.png" alt="Logo" width="100%" height="100%">
155 +
156 +> #### 3. User board Page
157 +
158 +<p align="right">(<a href="#top">back to top</a>)</p>
159 +
160 +
161 +<!-- ROADMAP -->
162 +## Roadmap
163 +
164 +> - 로그인 기능 구현
165 +> - 회원가입 기능 구현 (Id, mbti, password 입력)
166 +> - 사용자 게시판 구현
167 +> - [x] mbti 사용한 매칭 기능
168 +> - [o] 내용
169 +
170 +<p align="right">(<a href="#top">back to top</a>)</p>
171 +
172 +
173 +
174 +<!-- CONTRIBUTING -->
175 +## Contributing
176 +
177 +게시판에 아이디어를 추가하고 싶다면...
178 +
179 +> 1. Fork the Project
180 +> 2. Create your Feature Branch (`git checkout -b feature/"추가된 아이디어 이름"`)
181 +> 3. Commit your Changes (`git commit -m 'Added features`)
182 +> 4. Push to the Branch (`git push origin feature/"추가된 아이디어 이름"`)
183 +> 5. Open a Pull Request
184 +
185 +<p align="right">(<a href="#top">back to top</a>)</p>
186 +
187 +
188 +
189 +<!-- LICENSE -->
190 +## License
191 +
192 +Distributed under the [MIT License](License).
193 +
194 +<p align="right">(<a href="#top">back to top</a>)</p>
195 +
196 +
197 +
198 +<!-- CONTACT -->
199 +## Contact
200 +
201 +> - 오인제 (seanoh@khu.ac.kr)
202 +> - 정의왕 (@khu.ac.kr)
203 +> - 고병후 (@khu.ac.kr)
204 +
205 +Project Link: [http://khuhub.khu.ac.kr/2019102198/Tunnel.git](http://khuhub.khu.ac.kr/2019102198/Tunnel.git)
206 +
207 +<p align="right">(<a href="#top">back to top</a>)</p>
...\ No newline at end of file ...\ No newline at end of file