README.md



맛집지도 : 실시간 맛집 정보 공유 플랫폼

카카오맵 API와 실시간 채팅 기능을 통해 사용자들과 소통함으로써 맛집에 대한 정보를 얻을 수 있는 플랫폼입니다.


📚 STACKS


About the Project


회원가입 및 로그인을 통해 사이트에 들어갈 수 있습니다.
메인 화면에서는 지역별 맛집정보를 파악할 수 있습니다.
실시간 채팅을 통해 타 유저들과 해당 음식점의 실시간 정보를 빠르게 공유할 수 있습니다.
다음의 주소를 통해 플랫폼 이용이 가능합니다.


Overview


Project Architecture


Built With


node.js
express
AWS_EC2
AWS_RDS
socket.io
nginx
mysql


Getting Started ( Installation )


Preparation

Need to write secret file


favorite-restaurant/app/.env


#Database configuration
PORT=3000

DB_HOST = {YOUR_MYSQL_HOST}
DB_USER = {YOUR_MYSQL_USER}
DB_PASSWORD = {YOUR_MYSQL_PASSWORD}
DB_DATABASE = {YOUR_MYSQL_SCHEMA}


Need to fix kakaomap API key


favorite-restaurant/app/src/view/home/index.ejs


#Line number 50
src="//dapi.kakao.com/v2/maps/sdk.js?appkey=이곳에API키를입력해주세요&libraries=services"


Installation


Clone the repository


git clone -b master --single-branch http://khuhub.khu.ac.kr/2018100910/favorite_restaurant.git


Make secret file (.env) and put your Kakao API key


favorite-restaurant/app/.env


Installation


npm install
npm -g install nodemon
npm install express
npm install socket.io
npm install moment
npm install


Run


npm start


Roadmap


 1. 로그인/회원가입 UI 및 기능 구현

 2. 맛집지도 UI 및 기능 구현

 3. socket.io를 이용한 실시간 채팅 구현

 4. AWS, Mysql을 이용한 데이터베이스 구축

 5. 서버 구축 및 배포


Contributing

프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.


프로젝트 fork
feature branch 생성 (git checkout -b feature/name)
commit (git commit -m "Add feature")
push (git push origin feature/name)
pull request 생성


License

MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한 정보를 확인하세요.


Contact


서정민 : balljm@khu.ac.kr
양주미 : luckyyjm@khu.ac.kr