Update README.md and Add license

Jumi Yang
Commit 0584ef24101a8057538b7a63b31c5c47a5f8c4ef 0584ef24 1 parent 0618afd1
Showing 2 changed files with 78 additions and 15 deletions
LICENSE.txt
README.md
--- a/LICENSE.txt 0 → 100644
View file @0584ef2
+++ b/LICENSE.txt 0 → 100644
View file @0584ef2
+MIT License
+Copyright (c) 2022 Jeongmin Seo
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
\ No newline at end of file
--- a/README.md
View file @0584ef2
+++ b/README.md
View file @0584ef2
 # 맛집지도 : 실시간 맛집 정보 공유 플랫폼
+카카오맵 API와 실시간 채팅 기능을 통해 사용자들과 소통함으로써 맛집에 대한 정보를 얻을 수 있는 플랫폼입니다.
 <div align="center">
-    <h4>📚 STACKS</h4>
+    <img src="/uploads/f2c62af097272859d8f37acda908d6aa/그림1.png" width="300" height="300">
 </div>
-<div align="center">
+
-    <img src="https://img.shields.io/badge/html-E34F26?style=for-the-badge&logo=html5&logoColor=white"> <img src="https://img.shields.io/badge/css-1572B6?style=for-the-badge&logo=css3&logoColor=white"> <img src="https://img.shields.io/badge/node.js-339933?style=for-the-badge&logo=Node.js&logoColor=white"> <img src="https://img.shields.io/badge/express-000000?style=for-the-badge&logo=express&logoColor=white">
+### 📚 STACKS
-    <br>
+![node-16.14.2](https://img.shields.io/badge/Node-16.14.2-green)
-    <img src="https://img.shields.io/badge/AWS EC2-232F3E?style=for-the-badge&logo=amazon%20aws&logoColor=white"/> <img src="https://img.shields.io/badge/NGINX-009639?style=for-the-badge&logo=NGINX&logoColor=white"> <img src="https://img.shields.io/badge/socket.io-010101?style=for-the-badge&logo=socket.io&logoColor=white">
+![express-4.18.1](https://img.shields.io/badge/Express-4.18.1-green)
-    <br>
+![html-latest](https://img.shields.io/badge/html-5.2-green)
-    <img src="https://img.shields.io/badge/AWS RDS-232F3E?style=for-the-badge&logo=amazon%20aws&logoColor=white"/> <img src="https://img.shields.io/badge/mysql-4479A1?style=for-the-badge&logo=mysql&logoColor=white">
+![css-latest](https://img.shields.io/badge/css-3-green)
-    <br>
+    
-</div>
+![nginx-latest](https://img.shields.io/badge/nginx-latest-blue)
-<div align="center">
+![socket.io-latest](https://img.shields.io/badge/socket.io-latest-blue)
-    <img src="/uploads/f2c62af097272859d8f37acda908d6aa/그림1.png" width="200" height="200">
+![AWS_RDS](https://img.shields.io/badge/AWS_RDS-blue)
-</div>
+     
-<br>
+![mysql-2.18.1](https://img.shields.io/badge/Mysql-2.18.1-yellowgreen)
+![AWS_RDS](https://img.shields.io/badge/AWS_RDS-yellowgreen)
+
+
+
+
 ## About the Project
+- 로그인을 통해 사이트에 들어갈 수 있으며, 지역별 맛집정보를 파악할 수 있습니다.
+- 타 유저들과 실시간 소통을 통해 맛집에 대한 정보를 빠르게 얻을 수 있습니다.
+
+### Overview
+- 추가 예정(이미지)
+
+### Project Architecture
+- 추가 예정(이미지)
+
+### Built With
+- [node.js](https://nodejs.org/ko/)
+- [express](https://expressjs.com/ko/)
+- [AWS_EC2](https://aws.amazon.com/ko/)
+- [AWS_RDS](https://aws.amazon.com/ko/)
+- [socket.io](https://socket.io/)
+- [nginx](https://www.nginx.com/)
+- [mysql](https://www.mysql.com/)
+
 ## Getting Started ( Installation )
-## Usage
+### Prerequisites
+- 추가 예정
+
+### Installation
+- 추가 예정
+
 ## Roadmap
+- [x] 1. 로그인/회원가입 창 구현
+- [x] 2. 맛집지도 UI 및 기능 구현
+- [x] 3. socket.io를 이용한 실시간 채팅 구현
+- [x] 4. AWS, Mysql을 이용한 데이터베이스 구축
+- [ ] 5. 서버 구축 및 배포
+
 ## Contributing
+프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.
+1. 프로젝트 fork
+2. feature branch 생성 (git checkout -b feature/name)
+3. commit (git commit -m "Add feature")
+4. push (git push origin feature/name)
+5. pull request 생성
+
 ## License
-## Contact
\ No newline at end of file
+MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한 정보를 확인하세요.
+
+## Contact
+- 서정민 : balljm@khu.ac.kr
+- 양주미 : luckyyjm@khu.ac.kr
\ No newline at end of file