Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/r4ai/yumemi-passport-frontend

ゆめみパスポート フロントエンドコーディング試験
https://github.com/r4ai/yumemi-passport-frontend

Last synced: 20 days ago
JSON representation

ゆめみパスポート フロントエンドコーディング試験

Awesome Lists containing this project

README

        

# ゆめみパスポート フロントエンドコーディング試験

[![storybook](https://raw.githubusercontent.com/storybooks/brand/master/badge/badge-storybook.svg)](https://yumemi-passport-frontend-2024.r4ai.dev/storybook/?path=/docs/ui-button--docs)
[![codecov](https://codecov.io/gh/r4ai/yumemi-passport-frontend/graph/badge.svg?token=H2JGBR3MTY)](https://codecov.io/gh/r4ai/yumemi-passport-frontend)
[![CI](https://github.com/r4ai/yumemi-passport-frontend/actions/workflows/ci.yml/badge.svg)](https://github.com/r4ai/yumemi-passport-frontend/actions/workflows/ci.yml)
[![Publish to Cloudflare Pages](https://github.com/r4ai/yumemi-passport-frontend/actions/workflows/publish-to-cloudflare-pages.yml/badge.svg)](https://github.com/r4ai/yumemi-passport-frontend/actions/workflows/publish-to-cloudflare-pages.yml)

- ウェブサイト:https://yumemi-passport-frontend-2024.r4ai.dev/
- Storybook:https://yumemi-passport-frontend-2024.r4ai.dev/storybook/
- テストカバレッジ:https://app.codecov.io/gh/r4ai/yumemi-passport-frontend

## 🤖 Tech Stack

- **Build tool**: [Vite](https://vitejs.dev/)
- **UI Framework**: [React](https://react.dev/)
- **Styling**: [Panda CSS](https://panda-css.com/)
- **Routing**: [TanStack Router](https://tanstack.com/router/latest)
- **Data fetching**: [TanStack Query](https://tanstack.com/query/latest)
- **Charting**: [Recharts](https://recharts.org/)
- **Icons**: [Lucide](https://lucide.dev/)
- **Testing**:
- [Storybook](https://storybook.js.org/)
- [Vitest](https://vitest.dev/)

## 💻 Development

| コマンド | 説明 |
| ------------------------- | ----------------------------------------- |
| `bun install` | 依存関係のインストール |
| `bun run dev` | 開発サーバーの起動 |
| `bun run build` | ビルド |
| `bun run preview` | ビルド結果のプレビュー |
| `bun run storybook` | Storybookの起動 |
| `bun run storybook:build` | Storybookのビルド |
| `bun run storybook:test` | Storybookによるコンポーネントテストの実行 |
| `bun run vitest` | Vitestによる単体テストの実行 |
| `bun run format` | Prettierによるコードフォーマットの実行 |
| `bun run lint:fix` | ESLintによるコードのリントを実行 |

### 🚀 QuickStart

> [!WARNING]
> 実行には `.tool-versions` に記載されたバージョンの Node.js と Bun が必要です。
>
> mise もしくは asdf 等を利用している場合は、`mise install` もしくは `asdf install` によってインストールできます。

1. **環境変数の設定**

`.dev.vars.example` の内容を参考に、RESAS API Key を設定した `.dev.vars` ファイルを作成してください

2. **依存関係のインストール**

```sh
bun install
```

3. **開発サーバーの起動**

```sh
bun run dev
```

4. **Storybook の起動**

```sh
bun run storybook
```

5. **Storybookによるコンポーネントテストの実行**

```sh
bun run storybook:test
```

6. **Vitest による単体テストの実行**

```sh
bun run vitest
```

7. **ビルド**

```sh
bun run build
```