Skip to content

Team-inglo/Giggle-Web

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

GIGGLE

🏆 2024 공개SW개발자대회 우수작

Tests

1  Cover

복잡한 외국인 채용을 빠르고 간편하게 ✔️
외국인 유학생과 고용을 연결하는, 대한민국 1위 외국인 유학생 아르바이트 플랫폼, Giggle!
공고 검색, 서류 작성, 허가까지 한 번에 해결하세요. 간편하고 합법적으로 시작하세요 !

앱 다운로드

iOS

Android

서비스 개발 여정

https://youtu.be/PfW00paozHM?si=0qIEgXpjnI9DGKZO

DeepWiki

https://deepwiki.com/Team-inglo/Giggle-Web

Tech Stack

프로젝트 소개

외국인 유학생 구인 구직 플랫폼

혹시, 외국인 유학생을 고용하고 싶으신가요? 아니면 아르바이트를 구하고 계신 외국인 유학생이신가요?

한국에 거주하는 외국인 유학생은 20만 명을 넘어서며 매년 증가하고 있습니다. 하지만 외국인 유학생이 시간제 아르바이트를 하려면 시간제 취업허가가 반드시 필요합니다.

허가 방법을 몰라 막막하시거나, 허가를 받기 위해 불필요한 비용을 지불하신 적 있으신가요?

이제 Giggle과 함께라면 복잡한 과정은 그만! 모든 걱정을 한 번에 해결할 수 있습니다.

3 Slide 16_9 - 25

주요 기능 소개

  1. 간편한 공고 등록
  • 외국인 유학생을 위한 Giggle만의 맞춤형 공고로 올려보세요. Giggle은 외국인 유학생이 쉽게 공고를 발견하고 지원할 수 있도록 돕습니다.
  1. 맞춤형 공고 검색
  • 고유 추천 알고리즘으로 외국인 유학생을 위한 아르바이트 공고 확인 가능
  1. 간편한 서류 작성 및 제출
  • 시간제취업허가 취득 위한 필요 서류 3종 작성 및 수정, 파일 다운로드 기능 지원
  1. 안전한 취업 보장
  • 실제 허가 절차 및 서류 작성을 안내, 절차 이행 도움으로 합법 취업 보장
  1. 언어 장벽 해소
  • 사용자 유형에 따른 언어 제공 (유학생 - 영어 / 고용주 - 한국어)

이력서 등록1 공고추천알골 Frame (4) Frame (5) Frame (6) Frame (2) Frame (7) Frame (8)

데모 (24.11.26 기준)

https://youtu.be/1SjgSh4zOZI

  1. main 브랜치에서 코드 복사
git clone https://github.com/Team-inglo/Giggle-Web.git
  1. dependency 설치
pnpm i
  1. 환경 변수 설정

프로젝트 루트에 .env 파일을 생성하고 다음 변수를 설정하세요:

VITE_APP_API_GIGGLE_API_BASE_URL=your_api_url
VITE_APP_KAKAO_API_BASE_URL=https://dapi.kakao.com/v2/local
VITE_APP_EXTERNAL_API_BASE_URL=https://api.odcloud.kr/api/nts-businessman/v1
VITE_APP_EXTERNAL_API_KEY=your_external_api_key
VITE_APP_KAKAO_API_KEY=your_kakao_api_key
VITE_APP_KAKAO_REST_API_KEY=your_kakao_rest_api_key

  1. 코드 실행
pnpm run dev

프로젝트 구조

src/
├── __tests__/    # 테스트 파일 및 설정
│   ├── e2e/      # E2E 테스트 (Playwright)
│   ├── fixtures/ # 테스트 데이터
│   ├── mocks/    # 공통 모킹
│   └── utils/    # 테스트 유틸리티
├── api/          # API 호출 함수
├── assets/       # 이미지, 폰트 등 정적 리소스
├── components/   # 재사용 가능한 UI 컴포넌트
├── constants/    # 상수 정의
├── hooks/        # 커스텀 React 훅
├── pages/        # 페이지 컴포넌트
├── store/        # Zustand 상태 관리
├── style/        # 글로벌 스타일
├── types/        # TypeScript 타입 정의
└── utils/        # 유틸리티 함수

Commit convention

사용 방법 예시

  • ✨ feat: 어쩌구저쩌구 #이슈번호
Git Convention Description Gitmoji Gitmoji Code
feat 새로운 기능과 관련된 것 :sparkles:
fix 오류와 같은 것을 수정 🐛 :bug:
test 테스트를 추가하거나 수정 :white_check_mark:
docs 문서와 관련하여 수정한 부분 📝 :memo:
style 코드의 포맷, 세미콜론 누락 등, 코드 로직의 변화 없음 🎨 :art:
refactor 코드의 리팩토링 (기능 변화 없음) ♻️ :recycle:
build 빌드 관련 파일 수정 🛠️ :hammer_and_wrench:
chore 기타 작업(패키지 매니저 설정 등, production code 무관) 🔧 :wrench:

기여하기

  1. 이슈 생성 또는 확인
  2. 기능 브랜치 생성 (feature/기능명 또는 fix/버그명)
  3. 변경사항 커밋 (위의 커밋 컨벤션 준수)
  4. Pull Request 생성

라이센스

이 프로젝트는 Apache 2.0 라이센스를 사용합니다.

🧪 테스트 환경

Vitest + React Testing Library 도입 완료
Playwright E2E 테스트 도입 완료
GitHub Actions CI/CD 설정 완료
테스트 커버리지 80% 임계값 설정

테스트 실행

이 프로젝트는 Vitest와 React Testing Library를 사용한 포괄적인 테스트 환경을 제공합니다.

테스트 명령어

# 모든 유닛/통합 테스트 실행
pnpm test

# 감시 모드로 테스트 실행 (개발 중 권장)
pnpm test:watch

# 커버리지 포함 테스트 실행
pnpm test:coverage

# 브라우저에서 테스트 UI 실행
pnpm test:ui

# E2E 테스트 실행
pnpm test:e2e

# E2E 테스트 UI 모드로 실행
pnpm test:e2e:ui

# 모든 테스트 (유닛 + E2E) 실행
pnpm test:all

테스트 가이드라인

  • 📋 테스트 가이드라인: 유닛 테스트 가이드라인E2E 테스트 가이드 참조
  • 🎯 커버리지 목표: 전체 80% 이상, 신규 기능 90% 이상
  • 🧪 테스트 유형: 컴포넌트, 훅, 유틸리티, 통합, E2E 테스트
  • 📏 테스트 원칙: 사용자 관점에서 작성, AAA 패턴 준수
  • 🎭 E2E 테스트: Playwright를 활용한 브라우저 기반 테스트

테스트 파일 구조

src/
├── components/
│   └── Button/
│       ├── Button.tsx
│       └── Button.test.tsx       # 컴포넌트 테스트
├── hooks/
│   ├── useTalentSearch.ts
│   └── useTalentSearch.test.ts   # 커스텀 훅 테스트
└── __tests__/
    ├── e2e/                      # E2E 테스트
    │   ├── domains/              # 도메인별 E2E 테스트
    │   │   └── post/
    │   │       ├── creation.spec.ts
    │   │       └── validation.spec.ts
    │   ├── shared/               # 공통 E2E 유틸리티
    │   │   ├── fixtures/
    │   │   ├── helpers/
    │   │   └── mocks/
    │   └── README.md
    ├── integration/              # 통합 테스트
    ├── fixtures/                 # 테스트 데이터
    ├── mocks/                    # 공통 모킹
    ├── utils/                    # 테스트 유틸리티
    └── setup.ts                  # 테스트 환경 설정

About

[2024 공개소프트웨어 개발자대회 우수작 등재] 외국인 유학생을 위한 아르바이트 신청 관리 플랫폼 "Giggle" Web Repository

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 6

Languages