Skip to content

ooooo333i/Sejong_Mat_Jal_R

Repository files navigation

favicon# Sejong Mat-Jal-R (세종대 맛잘알)


🍚 Sejong Mat-Jal-R

세종대학교 주변 맛집 정보를 보여주는 웹과 앱입니다.

세종대학교 및 광진구 인근의 음식점 데이터를 기반으로 사용자에게 음식 유형, 매장 태그, 서비스 유형, 가격대 필터를 통해 맞춤형 맛집 정보를 제공하는 웹 애플리케이션입니다.


📋 프로젝트 설명

Sejong Mat-Jal-R은 React와 Material UI를 기반으로 구축된 음식점 탐색 웹과 앱입니다.
사용자는 원하는 조건을 선택해 세종대 주변의 다양한 맛집을 카드 형태로 간편하게 탐색할 수 있습니다.


💻 요구 사항

소프트웨어

  • Node.js: v14 이상
  • npm: v6 이상
  • React: v18 이상
  • Google Chrome (권장 브라우저)

하드웨어

  • 최소 4GB 메모리 이상
  • 1280px 이상의 화면 해상도 권장

⚙️ 설치 및 설정

📌 카카오 지도 API 설정 방법

본 프로젝트는 카카오 맵 API를 사용하므로, 사용자가 직접 발급한 JavaScript 앱 키가 필요합니다.
다음 절차를 따라 .env 파일을 설정하면 정상적으로 카카오맵 지도가 표시됩니다.

1. 카카오 디벨로퍼스 회원가입 및 앱 생성

  • 카카오 디벨로퍼스에 로그인 후 ‘내 애플리케이션’에서 새 앱을 생성하세요.
  • 앱 생성 후, 사이드 바 -> “앱 키” 선택
  • 그 중 JavaScript 키를 복사합니다 (예: 0123456789abcdef...)
  • 사이드바 -> 플랫폼으로 이동 후 Web 사이트 도메인 입력(default : http://localhost:3000) 및 저장.
  • 사이드바 -> 카카오맵 -> 활성화 설정 -> 상태 OFF -> 상태 ON.

2. .env 파일 생성

  • .env 파일을 생성하기 위해 우선 프로젝트를 클론합니다.
# 1. 프로젝트 클론
git clone https://github.com/ooooo333i/Sejong_Mat_Jal_R.git

sejongMJR_data_final.json 파일이 src/ 또는 src/data/ 폴더 안에 있어야 정상 작동합니다.

  • 프로젝트 루트 디렉토리에 .env 파일을 만들고 아래처럼 입력하세요:
REACT_APP_KAKAO_API_KEY=이곳에_이전에_복사한_JavaScript_키_입력(띄어쓰기 없이)
  • 예:
REACT_APP_KAKAO_API_KEY=0123456789abcdef1234567890abcdef

⚠️ .env 파일은 절대 GitHub 등 외부에 공개하지 마세요!


🚀 사용 방법 및 예시

1. 필터 선택

  • 음식 유형, 서비스 유형, 가격대는 드롭다운 + 슬라이더 UI로 구성
  • 음식 유형을 선택하면 해당 유형에 맞는 태그 버튼이 자동 생성됨
  • 태그 버튼을 클릭하면 해당 태그의 음식점만 필터링됨

2. 카드 목록 보기

  • 각 음식점의 이름, 주소, 전화번호, 이미지, 리뷰 수, 평점 등이 카드에 표시됨
  • 카드 왼쪽 하단 지도 그림 선택 시 대략적인 위치 정보 표시 및 카드 이미지 클릭 시 상세 페이지 이동

3. 예시 화면 및 링크

https://mjr.xtremegateway.com

example-ui


🧪 테스트 방법

다음과 같은 방식으로 확인 가능합니다:

  1. 해당 폴더로 이동 : cd sejong_mat_jal_r
  2. 패키지 설치 : npm install
  3. 개발 서버 실행 : npm start
  4. 다양한 필터 조합을 테스트
  5. 콘솔 로그 또는 카드 렌더링을 통해 필터 정확성 확인
  6. 스크롤 이동, 초기화 버튼 등 UI 기능 정상 작동 여부 확인

🤝 기여 방법

  1. 이 저장소를 포크하세요 (https://github.com/ooooo333i/Sejong-Mat-Jal-R.git)
  2. 새로운 브랜치를 생성하세요 (git checkout -b feature/my-feature)
  3. 변경사항을 커밋하세요 (git commit -m 'Add new feature')
  4. 브랜치에 푸시하세요 (git push origin feature/my-feature)
  5. Pull Request를 보내주세요 !

📄 라이선스

이 프로젝트는 MIT License 하에 배포됩니다.

MIT 라이선스는 다음을 허용합니다:

  • 개인 및 상업적 사용
  • 수정 및 배포
  • 사본 제작
  • 소프트웨어에 대한 저작권 및 라이선스 고지를 포함한 사용

단, 책임 및 보증이 없다는 조건이 포함됩니다.
자세한 내용은 LICENSE 파일을 참조하세요.


👤 저자 및 연락처


📚 참고 문헌

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 5