Merge branch 'master' of ssh://khuhub.khu.ac.kr:12959/2019102227/TermProject
Showing
2 changed files
with
97 additions
and
0 deletions
License
0 → 100644
1 | +The MIT License (MIT) | ||
2 | + | ||
3 | +Copyright (c) 2020 정성훈 | ||
4 | + | ||
5 | +Permission is hereby granted, free of charge, to any person obtaining a copy | ||
6 | +of this software and associated documentation files (the "Software"), to deal | ||
7 | +in the Software without restriction, including without limitation the rights | ||
8 | +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
9 | +copies of the Software, and to permit persons to whom the Software is | ||
10 | +furnished to do so, subject to the following conditions: | ||
11 | + | ||
12 | +The above copyright notice and this permission notice shall be included in all | ||
13 | +copies or substantial portions of the Software. | ||
14 | + | ||
15 | +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
16 | +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
17 | +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
18 | +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
19 | +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
20 | +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
21 | +SOFTWARE. |
README.md
0 → 100644
1 | +# MEALKHU | ||
2 | +MEALKHU는 경희대학생들의 식사고민을 덜어주기 위해 제작된 웹사이트입니다. 경희대 근처 생활권(정건, 마을)에 있는 식당들을 종류별로 카테고리화 했습니다. 랜딩페이지에서 랜덤추천 및 mealkhu맵을 이용할 수 있고, 메뉴페이지에서 메뉴별 식당들을 조회할 수 있습니다. pick기능으로 원하는 식당을 mypick에 담아 둘 수 있습니다. | ||
3 | + | ||
4 | +## site | ||
5 | +http://www.mealkhu.tk/ | ||
6 | + | ||
7 | +## How to install | ||
8 | +1. clone : 로컬로 저장소를 클론합니다. | ||
9 | +``` | ||
10 | +$ git clone http://khuhub.khu.ac.kr/2019102227/TermProject.git | ||
11 | +``` | ||
12 | +2. npm install : 루트 디렉토리에서 아래의 명령어로 모듈들을 설치합니다. | ||
13 | +``` | ||
14 | +$ npm install && cd client && npm install | ||
15 | +``` | ||
16 | + | ||
17 | +## How to use | ||
18 | +- react 서버 실행 방법 : 루트 디렉토리에서 아래의 명령어를 실행합니다. | ||
19 | +``` | ||
20 | +$ npm run client | ||
21 | +``` | ||
22 | +- node 서버 실행 방법 : 루트 디렉토리에서 아래의 명령어를 실행합니다. | ||
23 | +``` | ||
24 | +$ npm run server | ||
25 | +``` | ||
26 | +- react, node 서버 동시 실행 방법 : 루트 디렉토리에서 아래의 명령어를 실행합니다. | ||
27 | +``` | ||
28 | +$ npm run dev | ||
29 | +``` | ||
30 | + | ||
31 | +- 데이터 custom 하기 : 루트 디렉토리에 json_datas.json이름의 파일을 생성하고, 아래의 형식처럼 데이터들을 저장해줍니다. | ||
32 | +``` | ||
33 | +[ | ||
34 | + { | ||
35 | + "id": "1", | ||
36 | + "name": "식당이름", | ||
37 | + "address": "식당주소", | ||
38 | + "latitude": "위도", | ||
39 | + "longitude": "경도", | ||
40 | + "type": "식당종류", (ex : '한식', '중식', '일식', '고기', '분식', '호프', '술집', '패스트푸드', '카페', '디저트', '기타') | ||
41 | + "menu": "메뉴", | ||
42 | + "img": "이미지", | ||
43 | + "img_source": "이미지출처" | ||
44 | + }, ... | ||
45 | + ] | ||
46 | +``` | ||
47 | + | ||
48 | +- 각종 key들 설정법 | ||
49 | +``` | ||
50 | +// database.json | ||
51 | +{ | ||
52 | + "host":"호스트", | ||
53 | + "user":"유저", | ||
54 | + "password":"비밀번호", | ||
55 | + "port":"포트번호", | ||
56 | + "database":"database이름" | ||
57 | +} | ||
58 | +// jwt_key.json | ||
59 | +{ | ||
60 | + "value": "키" | ||
61 | +} | ||
62 | +// client/config/appKey.json | ||
63 | +{ | ||
64 | + "value": "카카오API키" | ||
65 | +} | ||
66 | +``` | ||
67 | + | ||
68 | +## Tech Stack | ||
69 | +- React | ||
70 | +- Node.js | ||
71 | +- Mysql | ||
72 | +- Aws EC2 | ||
73 | +- Kakao Map Api | ||
74 | + | ||
75 | +## License | ||
76 | +MIT LICENSE | ||
... | \ No newline at end of file | ... | \ No newline at end of file |
-
Please register or login to post a comment