<div align="center">

<img width="1800" height="300" alt="Image" src="https://github.com/user-attachments/assets/420a15cc-5be3-447f-9c64-068e946cb118" /> <br>

</div>

# BIGTABLET Frontend Template

[![npm version](https://img.shields.io/npm/v/@bigtablet/create-frontend.svg)](https://www.npmjs.com/package/@bigtablet/create-frontend)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Bigtablet/.github/blob/main/BIGTABLET_LICENSE.md)
[![Architecture](https://img.shields.io/badge/docs-architecture-blue)](https://github.com/Bigtablet/bigtablet-frontend-template/blob/main/docs/architecture.md)

---

## 사용 방법

BIGTABLET Frontend Template는 CLI 형태로 제공되며,  
`npx`를 통해 별도의 설치 없이 바로 사용할 수 있습니다.

### 프로젝트 생성

아래 명령어를 실행하면 지정한 이름의 디렉터리에  
Bigtablet 표준 프론트엔드 프로젝트가 생성됩니다.

```bash
npx @bigtablet/create-frontend my-app
```

또는 다음 명령어도 동일하게 동작합니다.
```bash
npx create-bigtablet-frontend my-app
```

### 프로젝트 실행

프로젝트 생성이 완료되면, 생성된 디렉터리로 이동한 뒤  
개발 서버를 실행합니다.

```bash
cd my-app
pnpm run dev
```

개발 서버가 실행되면 브라우저에서 아래 주소로 접속할 수 있습니다.

```link
http://localhost:3000
```

### 요구 사항

이 템플릿을 사용하기 위해 아래 환경이 필요합니다.

- Node.js 20 LTS 이상 권장
- 패키지 매니저: pnpm

pnpm이 설치되어 있지 않은 경우 아래 명령어로 설치할 수 있습니다.

```bash
npm install -g pnpm
```

## 관련 링크

- Bigtablet Design System  
  https://www.npmjs.com/package/@bigtablet/design-system

- GitHub Repository  
  https://github.com/Bigtablet/bigtablet-frontend-template

- Architecture Guide  
  https://github.com/Bigtablet/bigtablet-frontend-template/blob/main/docs/architecture.md
