정성훈

Add README

Showing 1 changed file with 68 additions and 0 deletions
1 +# MEALKHU
2 +MEALKHU는 경희대학생들의 식사고민을 덜어주기 위해 제작된 웹사이트입니다. 경희대 근처 생활권(정건, 마을)에 있는 식당들을 종류별로 카테고리화 했습니다. 랜딩페이지에서 랜덤추천 및 mealkhu맵을 이용할 수 있고, 메뉴페이지에서 메뉴별 식당들을 조회할 수 있습니다. pick기능으로 원하는 식당을 mypick에 담아 둘 수 있습니다.
3 +## How to install
4 +1. clone : 로컬로 저장소를 클론합니다.
5 +```bash
6 +$ git clone http://khuhub.khu.ac.kr/2019102227/TermProject.git
7 +```
8 +2. npm install : 루트 디렉토리에서 아래의 명령어로 모듈들을 설치합니다.
9 +```bash
10 +$ npm install && cd client && npm install
11 +```
12 +## How to use
13 +- react 서버 실행 방법 : 루트 디렉토리에서 아래의 명령어를 실행합니다.
14 +```bash
15 +$ npm run client
16 +```
17 +- node 서버 실행 방법 : 루트 디렉토리에서 아래의 명령어를 실행합니다.
18 +```bash
19 +$ npm run server
20 +```
21 +- react, node 서버 동시 실행 방법 : 루트 디렉토리에서 아래의 명령어를 실행합니다.
22 +```bash
23 +$ npm run dev
24 +```
25 +- 데이터 custom 하기 : 루트 디렉토리에 json_datas.json 파일을 생성하고, 아래의 형식처럼 데이터들을 저장해줍니다.
26 +```javascript
27 +[
28 + {
29 + "id": "1",
30 + "name": "식당이름",
31 + "address": "식당주소",
32 + "latitude": "위도",
33 + "longitude": "경도",
34 + "type": "식당종류", (ex : '한식', '중식', '일식', '고기', '분식', '호프', '술집', '패스트푸드', '카페', '디저트', '기타')
35 + "menu": "메뉴",
36 + "img": "이미지",
37 + "img_source": "이미지출처"
38 + }, ...
39 + ]
40 +```
41 +- 각종 key들 설정법
42 +```bash
43 +// database.json
44 +{
45 + "host":"호스트",
46 + "user":"유저",
47 + "password":"비밀번호",
48 + "port":"포트번호",
49 + "database":"database이름"
50 +}
51 +// jwt_key.json
52 +{
53 + "value": "키"
54 +}
55 +// client/config/appKey.json
56 +{
57 + "value": "카카오API키"
58 +}
59 +```
60 +
61 +## Tech Stack
62 +- React
63 +- Node.js
64 +- Mysql
65 +- Aws EC2
66 +- Kakao Map Api
67 +## License
68 +MIT LICENSE
...\ No newline at end of file ...\ No newline at end of file