Hevy-Insights

(★ 106)

Hevy Insights is a used to gather data from Hevy API and visualize it in a GUI.

  • .env.example
  • .gitignore
  • .markdownlint.json
  • CONTRIBUTING.md
  • docker-compose.yaml
  • LICENSE
  • README.md
  • ruff.toml
  • SECURITY.md

# 설치 가이드

1. 코드 내려받기
git clone https://github.com/casudo/Hevy-Insights

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd Hevy-Insights

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Docker

쉬움 추천
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Docker Desktop 컨테이너를 빌드하고 실행하려면 필요합니다. 설치 후 실행해서 백그라운드에 켜두세요.
│ ├── .dockerignore # Docker ignore file for backend

이 명령어를 터미널에 그대로 입력해 실행하세요.

├── .dockerignore # Docker ignore file for frontend

이 명령어를 터미널에 그대로 입력해 실행하세요.

터미널에 docker compose ps 를 입력해 컨테이너들이 Up 상태인지 확인하세요. README에 포트 번호가 적혀있다면 브라우저에서 http://localhost:포트번호 로 접속해보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

3. Node.js

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Node.js npm 명령어를 쓰려면 Node.js가 설치되어 있어야 합니다. LTS(장기지원) 버전을 추천합니다.
├── package-lock.json # npm package lock file

이 명령어를 터미널에 그대로 입력해 실행하세요.

명령어 실행 후 터미널에 나타나는 주소(보통 http://localhost:3000 형태)를 브라우저에서 열어보세요.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

4. Python

쉬움
사전 준비물
  • Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
  • Python 3 설치 시 'Add Python to PATH' 옵션을 꼭 체크하세요 (Windows).
pip install -r backend/requirements.txt

requirements.txt 등에 명시된 파이썬 라이브러리를 설치합니다.

python <실행할 파일명>.py # README에서 정확한 실행 파일명을 확인하세요

파이썬 스크립트(또는 모듈)를 실행합니다.

에러 메시지 없이 실행되고 터미널에 안내 문구가 출력되면 정상입니다.
// repository documentation