Toggle navigation
Toggle navigation
This project
Loading...
Sign in
Jeongmin Seo
/
favorite_restaurant
Go to a project
Toggle navigation
Toggle navigation pinning
Projects
Groups
Snippets
Help
Project
Activity
Repository
Pipelines
Graphs
Issues
0
Merge Requests
0
Wiki
Snippets
Network
Create a new issue
Builds
Commits
Issue Boards
Authored by
Jeongmin Seo
2022-06-09 14:36:19 +0900
Browse Files
Options
Browse Files
Download
Email Patches
Plain Diff
Commit
86b01cb9de80a5a065a737c8d178d9c1a446edae
86b01cb9
1 parent
cd4a139a
Update README.md
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
80 additions
and
12 deletions
README.md
README.md
View file @
86b01cb
# 맛집지도 : 실시간 맛집 정보 공유 플랫폼
카카오맵 API와 실시간 채팅 기능을 통해 사용자들과 소통함으로써 맛집에 대한 정보를 얻을 수 있는 플랫폼입니다.
<div
align=
"center"
>
<img
src=
"/uploads/
f2c62af097272859d8f37acda908d6aa/그림1
.png"
width=
"300"
height=
"300"
>
<img
src=
"/uploads/
6f062fddb950cee4e27b99e9f337ebbf/로고
.png"
width=
"300"
height=
"300"
>
</div>
### 📚 STACKS
![
node-16.14.2
](
https://img.shields.io/badge/Node-16.14.2-green
)
![
express-4.18.1
](
https://img.shields.io/badge/Express-4.18.1-green
)
![
html-latest
](
https://img.shields.io/badge/html-5.2-green
)
...
...
@@ -13,23 +15,32 @@
![
nginx-latest
](
https://img.shields.io/badge/nginx-latest-blue
)
![
socket.io-latest
](
https://img.shields.io/badge/socket.io-latest-blue
)
![
AWS_
RDS
](
https://img.shields.io/badge/AWS_RDS
-blue
)
![
AWS_
EC2
](
https://img.shields.io/badge/AWS_EC2
-blue
)
![
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
-
추가 예정(이미지)
<div
align=
"center"
>
<img
src=
"/uploads/4205b64858a27863e564579998ce0461/overview.png"
>
</div>
### Project Architecture
-
추가 예정(이미지)
<div
align=
"center"
>
<img
src=
"/uploads/af7ba588e17279d3f7713b5bf3662f66/아키텍처.png"
>
</div>
### Built With
-
[
node.js
](
https://nodejs.org/ko/
)
-
[
express
](
https://expressjs.com/ko/
)
-
[
AWS_EC2
](
https://aws.amazon.com/ko/
)
...
...
@@ -39,21 +50,76 @@
-
[
mysql
](
https://www.mysql.com/
)
## Getting Started ( Installation )
### Prerequisites
-
추가 예정
### 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
-
추가 예정
1.
Clone the repository
```
git clone -b master --single-branch http://khuhub.khu.ac.kr/2018100910/favorite_restaurant.git
```
2.
Make secret file (.env) and put your Kakao API key
```
favorite-restaurant/app/.env
```
3.
Installation
```
npm install
npm -g install nodemon
npm install express
npm install socket.io
npm install moment
npm install
```
4.
Run
```
npm start
```
## Roadmap
-
[
x
]
1. 로그인/회원가입 창 구현
-
[
x
]
1. 로그인/회원가입 UI 및 기능 구현
-
[
x
]
2. 맛집지도 UI 및 기능 구현
-
[
x
]
3. socket.io를 이용한 실시간 채팅 구현
-
[
x
]
4. AWS, Mysql을 이용한 데이터베이스 구축
-
[
]
5. 서버 구축 및 배포
-
[
x
]
5. 서버 구축 및 배포
## Contributing
프로젝트에 기여하고 싶으신 분들은 아래 절차를 따라주시기 바랍니다.
1.
프로젝트 fork
2.
feature branch 생성 (git checkout -b feature/name)
3.
commit (git commit -m "Add feature")
...
...
@@ -61,8 +127,10 @@
5.
pull request 생성
## License
MIT 라이센스 아래 사용 가능합니다. LICENSE.txt를 통해 자세한 정보를 확인하세요.
## Contact
-
서정민 : balljm@khu.ac.kr
-
양주미 : luckyyjm@khu.ac.kr
...
...
Please
register
or
login
to post a comment