Skip to content

beom-jo-city/catch_mind

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 설치 및 실행 방법

1. 사전 준비

프로젝트 실행 전에 아래 프로그램을 설치해야 합니다.

설치 후, 터미널에서 설치된 버전을 확인

node -v  # Node.js 버전 출력
npm -v   # npm 버전 출력

2. 프로젝트 설치

원격 레포지토리 클론 후, feat-1/FE 브랜치를 로컬로 가져오고 체크아웃

git clone <https://github.com/beom-jo-city/catch_mind.git
# 클론할 폴더 IDE에서 불러오기
git checkout -b feat-1/FE origin/feat-1/FE  # feat-1/FE 브랜치를 로컬로 가져오고 체크아웃
cd ai-catchmind     # React 프로젝트

의존성 설치 - package.json에 정의된 모든 패키지를 설치

npm install

웹 서버 실행

npm start

명령 실행 후 기본 브라우저가 자동으로 열리며, http://localhost:3000에서 확인 가능

📂 프로젝트 구조

프로젝트의 주요 폴더와 파일 구조는 다음과 같습니다.

ai-catchmind/
├── src/                           # React 소스 코드가 위치한 디렉토리
│   ├── api/                       # FastAPI와 통신하는 API 함수 모듈화
│   │   ├── api.js                 # FastAPI와의 키워드, 캔버스 데이터 전송 함수 정의
│   ├── assets/                    # 프로젝트에 사용되는 정적 자산 저장
│   │   ├── title.png              # Home 화면 로고 이미지
│   ├── components/                # React 컴포넌트 관리 디렉토리
│   │   ├── Home.js                # Home 화면 (Start, Quit, Developer 버튼 및 리더보드)
│   │   ├── Home.css               # Home 화면의 스타일링 정의
│   │   ├── Choice.js              # Quickdraw 제시어 선택 및 Canvas로 데이터 전달
│   │   ├── Choice.css             # Choice 화면의 스타일링 정의
│   │   ├── Canvas.js              # 캔버스 및 추론 결과 화면 구현
│   │   ├── Canvas.css             # Canvas 화면의 스타일링 정의
│   ├── App.js                     # 라우터 설정 및 전체 애플리케이션 관리
│   ├── index.js                   # React 애플리케이션의 진입점
│   ├── index.css                  # 글로벌 스타일 정의
├── public/                        # 정적 파일 제공 디렉토리 (빌드된 파일이 저장될 위치)
│   ├── index.html                 # React 애플리케이션의 HTML 템플릿
├── package.json                   # 프로젝트의 의존성 및 스크립트 설정
├── package-lock.json              # 의존성 설치 시 버전 고정을 위한 파일
├── README.md                      # 프로젝트 설명 및 사용 방법

  • src/ 폴더: 프로젝트의 핵심 코드가 위치합니다. React 컴포넌트, 스타일 파일 등을 포함합니다.
  • public/ 폴더: 정적 리소스가 저장됩니다. 여기 있는 파일은 npm start 실행 시 브라우저에 그대로 노출됩니다.
  • package.json 파일: 프로젝트 의존성과 실행 가능한 스크립트(npm start, npm install 등)가 정의되어 있습니다.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors