update README

seanoh
Commit 0948082846f705362d72ff930d18fa1e8aa6478e 09480828 1 parent 5c9b66f1
Showing 1 changed file with 252 additions and 0 deletions
README.md
--- a/README.md 0 → 100644
View file @0948082
+++ b/README.md 0 → 100644
View file @0948082
+ <div id="top"></div>
+ <!--
+ *** Thanks for checking out the Best-README-Template. If you have a suggestion
+ *** that would make this better, please fork the repo and create a pull request
+ *** or simply open an issue with the tag "enhancement".
+ *** Don't forget to give the project a star!
+ *** Thanks again! Now go create something AMAZING! :D
+ -->
+ 
+ 
+ 
+ <!-- PROJECT SHIELDS -->
+ <!--
+ *** I'm using markdown "reference style" links for readability.
+ *** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+ *** See the bottom of this document for the declaration of the reference variables
+ *** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+ *** https://www.markdownguide.org/basic-syntax/#reference-style-links
+ -->
+ 
+ <!-- PROJECT LOGO -->
+ <br />
+ <div align="center">
+   <a href="http://khuhub.khu.ac.kr/2019102198/Tunnel.git">
+     <img src="https://images.christiantoday.co.kr/data/images/full/332493/image.jpg" alt="Logo" width="50%" height="50%">
+   </a>
+ 
+ <h1 align="center">익명 고민상담 서비스</h1>
+ </div>
+ 
+ 
+ 
+ <!-- TABLE OF CONTENTS -->
+ <br>
+   <h3>목차</h3>
+   <ol>
+     <li>
+       <a href="#about-the-project">About The Project</a>
+       <ul>
+         <li><a href="#built-with">Built With</a></li>
+       </ul>
+     </li>
+     <li>
+       <a href="#getting-started">Getting Started</a>
+       <ul>
+         <li><a href="#installation">Installation</a></li>
+         <li><a href="#prerequisites">Prerequisites</a></li>
+       </ul>
+     </li>
+     <li><a href="#DB Schema">DB Schema</a></li>
+     <li><a href="#usage">Usage</a></li>
+     <li><a href="#roadmap">Roadmap</a></li>
+     <li><a href="#contributing">Contributing</a></li>
+     <li><a href="#license">License</a></li>
+     <li><a href="#contact">Contact</a></li>
+   </ol>
+ </br>
+ 
+ 
+ 
+ <!-- ABOUT THE PROJECT -->
+ ## About The Project
+ 
+ > 터널과 같이 앞길이 깜깜한 인생 고민, mbti와 아이디 비밀번호만 입력하면 익명의 사용자들에게 고민 상담을 받을 수 있습니다!
+ 
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ 
+ 
+ ### Built With
+ 
+ > * [React.js](https://reactjs.org/) -- front end
+ > * [Node.js](https://nodejs.org/) -- back end
+ > * [MySQL](https://www.mysql.com/) -- database
+ > * [AWS](https://aws.amazon.com/) -- server
+ 
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ 
+ 
+ <!-- GETTING STARTED -->
+ ## Getting Started
+ 
+ * Install
+ 
+ > 1. Git
+ > 2. Node JS
+ > 3. MySQL
+ 
+ ### Installation
+ 
+ * 1. Clone repository
+    ```sh
+     git clone http://khuhub.khu.ac.kr/2019102198/Tunnel.git
+    ``` 
+    
+ 
+ * 2. Install NPM packages
+   ```sh
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel> cd tunnel_BE
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE> cd server
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE\server> npm install
+   ```
+   ```sh
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE\server> cd ..  
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\tunnel_BE> cd..
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel> cd turnel_FE
+     PS C:\Users\seano\Desktop\git_OSS\OSS project\Tunnel\turnel_FE> npm install 
+   ```
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ ### Prerequisites
+ * Login MySQL / Create database
+    ```sh
+     윈도우 + R ---> cmd 실행창 열기
+    ``` 
+    ```sh
+     C:\Users\seano>cd..
+     C:\Users>cd..
+     C:\>cd "Program Files"
+     C:\Program Files>cd MySQL
+     C:\Program Files\MySQL>cd "MySQL Server 8.0"
+     C:\Program Files\MySQL\MySQL Server 8.0>cd bin
+     C:\Program Files\MySQL\MySQL Server 8.0\bin>mysql -h localhost -u root -p
+     Enter password: **********
+     Welcome to the MySQL monitor.  Commands end with ; or \g.
+     Your MySQL connection id is 27
+     Server version: 8.0.19 MySQL Community Server - GPL
+ 
+     Copyright (c) 2000, 2020, Oracle and/or its affiliates. All rights reserved.
+ 
+     Oracle is a registered trademark of Oracle Corporation and/or its
+     affiliates. Other names may be trademarks of their respective
+     owners.
+ 
+     Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
+ 
+     mysql> CREATE SCHEMA tunnel DEFAULT CHARACTER SET utf8;
+     Query OK, 1 row affected, 1 warning (0.04 sec)
+    ```
+ * AWS 서버 설정
+   ```sh
+ 
+   ```
+ 
+ ## DB Schema
+ * users 사용자: utf-8
+ 
+   |Column|Type|Information|
+   |---|---|---|
+   |id|int|key, 자동생성|
+   |name|string|User가 작성한 Id|
+   |pw|string||
+   |mbti|CHAR(4)|16가지중 1개만 저장|
+   |update|Bool|업데이트 여부(새 고민도착, 새 댓글 도착 여부)|
+ 
+ * posts 게시글: utf-8
+ 
+   |Column|Type|Information|
+   |---|---|---|
+   |id|int|key, 자동생성|
+   |userid|string|foreign key (users.name) / 부모 삭제시 삭제|
+   |post|text|게시글|
+   |title|text|제목|
+   |update|Bool|업데이트 여부(새 댓글 작성 여부)|
+   |created_at|time|작성시간|
+ 
+ * comment 댓글: utf-8
+ 
+   |Column|Type|Information|
+   |---|---|---|
+   |id|int|key, 자동생성|
+   |postid|int||
+   |userid|text|foreign key (users.id) / 부모 삭제시 삭제|
+   |comment|text|댓글 정보|
+   |created_at|time|작성시간|
+ 
+ <!-- USAGE EXAMPLES -->
+ ## Usage
+ > ### 용도 설명
+ 
+ > #### 1. Login Page
+ > - http://localhost:3000/login
+ <img src="images/login.png" alt="Logo" width="100%" height="100%">
+ 
+ > #### 2. Register Page
+ > - http://localhost:3000/register
+ <img src="images/register.png" alt="Logo" width="100%" height="100%">
+ 
+ > #### 3. User board Page
+ > - http://localhost:3000/main
+ <img src="images/board.png" alt="Logo" width="100%" height="100%">
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ 
+ <!-- ROADMAP -->
+ ## Roadmap
+ 
+ > - 회원가입 기능 구현 (Id, mbti, password, password 재확인 입력)
+ >    - 중복된 Id 유무 확인, 중복시 재입력 요구
+ >    - password, password 재확인 일치 여부 확인
+ >    - 모든 문제 없다면, 회원정보 DB에 저장, 로그인 화면 이동
+ > - 로그인 기능 구현
+ >    - Id/Password 받아서 회원정보 DB에 Id로 탐색 후 Password 일치 여부 확인
+ >    - 모든 문제 없다면, 게시판 화면 이동
+ > - 사용자 게시판 구현
+ >    - 내 계정정보, mbti 표시
+ >    - 내 게시글 시간순으로 나열
+ >    - 게시글 밑에 댓글 수 표시
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ 
+ 
+ <!-- CONTRIBUTING -->
+ ## Contributing
+ 
+ 게시판에 아이디어를 추가하고 싶다면...
+ 
+ > 1. Fork the Project
+ > 2. Create your Feature Branch (`git checkout -b feature/"추가된 아이디어 이름"`)
+ > 3. Commit your Changes (`git commit -m 'Added features`)
+ > 4. Push to the Branch (`git push origin feature/"추가된 아이디어 이름"`)
+ > 5. Open a Pull Request
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ 
+ 
+ <!-- LICENSE -->
+ ## License
+ 
+ Distributed under the [MIT License](License).
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
+ 
+ 
+ 
+ <!-- CONTACT -->
+ ## Contact
+ 
+ > - 오인제 (seanoh@khu.ac.kr)
+ > - 정의왕 (wang323@khu.ac.kr)
+ > - 고병후 (gobyeonghu@ khu.ac.kr)
+ 
+ Project Link: [http://khuhub.khu.ac.kr/2019102198/Tunnel.git](http://khuhub.khu.ac.kr/2019102198/Tunnel.git)
+ 
+ <p align="right">(<a href="#top">back to top</a>)</p>
\ No newline at end of file