Skip to content

Commit c3fcec2

Browse files
authored
Merge pull request #1 from hackdays-io/majorupdate/v1_0_0
Majorupdate/v1 0 0
2 parents 056e022 + 8ffa426 commit c3fcec2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+7513
-45
lines changed

.vscode/settings.json

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
{
2+
"editor.formatOnSave": true,
3+
"editor.defaultFormatter": "biomejs.biome",
4+
"editor.codeActionsOnSave": {
5+
"quickfix.biome": "explicit",
6+
"source.organizeImports.biome": "explicit"
7+
},
8+
"[typescript]": {
9+
"editor.defaultFormatter": "biomejs.biome"
10+
},
11+
"[typescriptreact]": {
12+
"editor.defaultFormatter": "biomejs.biome"
13+
},
14+
"[javascript]": {
15+
"editor.defaultFormatter": "biomejs.biome"
16+
},
17+
"[javascriptreact]": {
18+
"editor.defaultFormatter": "biomejs.biome"
19+
},
20+
"[json]": {
21+
"editor.defaultFormatter": "biomejs.biome"
22+
},
23+
"[jsonc]": {
24+
"editor.defaultFormatter": "biomejs.biome"
25+
}
26+
}

README.md

Lines changed: 97 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ Toban のランディングページプロジェクトです。
99
- **Emotion** - CSS-in-JS ライブラリ
1010
- **Biome** - リンター・フォーマッター
1111
- **Yarn** - パッケージマネージャー
12+
- **React Icons** - アイコンライブラリ
13+
- **Storybook** - コンポーネント開発環境
14+
- **serve** - 静的ファイル配信サーバー
1215

1316
## 📋 必要条件
1417

@@ -30,7 +33,15 @@ cd toban-lp
3033
yarn install
3134
```
3235

33-
### 3. 環境変数の設定
36+
### 3. 不足している依存関係のインストール
37+
38+
プロジェクトで使用されているアイコンライブラリをインストールします:
39+
40+
```bash
41+
yarn add react-icons
42+
```
43+
44+
### 4. 環境変数の設定
3445

3546
必要に応じて環境変数を設定してください:
3647

@@ -63,58 +74,127 @@ yarn build
6374
yarn start
6475
```
6576

77+
### 静的ファイルのエクスポート
78+
79+
このプロジェクトは静的サイトとしてビルドされます:
80+
81+
```bash
82+
yarn export
83+
```
84+
85+
### Storybookの起動
86+
87+
コンポーネントの開発・テスト用にStorybookを使用できます:
88+
89+
```bash
90+
yarn build-storybook
91+
```
92+
6693
## 🧹 コード品質
6794

68-
### リント
95+
### 自動フォーマット
96+
97+
このプロジェクトでは以下の方法でコード品質が自動的に管理されます:
98+
99+
#### 1. Git Hooks(推奨)
100+
- コミット前に自動的にBiomeのチェックと修正が実行されます
101+
- 問題がある場合はコミットがブロックされます
102+
- `lint-staged`により、ステージされたファイルのみが処理されます
103+
104+
#### 2. VS Code設定
105+
- ファイル保存時に自動フォーマットが適用されます
106+
- Biome拡張機能が推奨されます
107+
108+
#### 3. 手動実行
69109

70110
```bash
71111
# リントチェック
72112
yarn lint
73113

74114
# リント自動修正
75115
yarn lint:fix
76-
```
77-
78-
### フォーマット
79116

80-
```bash
81117
# コードフォーマット
82118
yarn format
83-
```
84119

85-
### 総合チェック
86-
87-
```bash
88-
# リント + フォーマットの総合チェック
120+
# 総合チェック(リント + フォーマット)
89121
yarn check
90122

91123
# 総合チェック + 自動修正
92-
yarn clean
124+
yarn check:fix
125+
126+
# 型チェック
127+
yarn type-check
93128
```
94129

130+
### 開発時の注意点
131+
132+
- コミット前に必ず`yarn check:fix`を実行することを推奨します
133+
- VS CodeでBiome拡張機能をインストールすると、リアルタイムでエラーが表示されます
134+
- プッシュ前にGitHub ActionsでBiomeチェックが実行されます
135+
95136
## 📁 プロジェクト構造
96137

97138
```
98139
toban-lp/
99140
├── public/ # 静的ファイル
100141
│ └── assets/ # アセットファイル
142+
│ ├── logo/ # ロゴファイル
143+
│ ├── HowItWorksImage/ # 説明画像
144+
│ ├── toban-logo.svg # Tobanロゴ
145+
│ ├── toban-logo-text.svg # Tobanテキストロゴ
146+
│ ├── hero-image.png # ヒーロー画像
147+
│ └── favicon.ico # ファビコン
101148
├── src/ # ソースコード
102149
│ ├── components/ # React コンポーネント
103150
│ │ ├── common/ # 共通コンポーネント
151+
│ │ │ └── Button.tsx # ボタンコンポーネント
104152
│ │ ├── layouts/ # レイアウトコンポーネント
153+
│ │ │ └── base.tsx # ベースレイアウト
105154
│ │ └── organisms/ # 複合コンポーネント
155+
│ │ ├── Header/ # ヘッダーコンポーネント
156+
│ │ ├── Footer/ # フッターコンポーネント
157+
│ │ ├── HeroSection.tsx # ヒーローセクション
158+
│ │ ├── Features.tsx # 機能紹介
159+
│ │ ├── ProblemSolution.tsx # 問題と解決策
160+
│ │ ├── HowItWorks.tsx # 使い方説明
161+
│ │ ├── UseCases.tsx # ユースケース
162+
│ │ ├── CaseStudies.tsx # 事例紹介
163+
│ │ ├── SecurityStack.tsx # セキュリティスタック
164+
│ │ ├── TrackRecord.tsx # 実績
165+
│ │ ├── Pricing.tsx # 料金プラン
166+
│ │ ├── Faq.tsx # よくある質問
167+
│ │ ├── AwardsMedia.tsx # 受賞・メディア
168+
│ │ ├── InfiniteLoop.tsx # 無限ループ
169+
│ │ └── GettingStarted.tsx # 始め方
106170
│ ├── data/ # データファイル
107171
│ ├── hooks/ # カスタムフック
108172
│ ├── locales/ # 国際化ファイル
109173
│ ├── pages/ # Next.js ページ
174+
│ │ ├── _app.tsx # アプリケーション設定
175+
│ │ ├── _document.tsx # ドキュメント設定
176+
│ │ └── index.tsx # メインページ
110177
│ ├── themes/ # テーマ設定
111-
│ │ ├── settings/ # テーマ設定
112-
│ │ └── styles/ # スタイル定義
178+
│ │ ├── settings/ # テーマ設定
179+
│ │ │ ├── color.ts # カラー設定
180+
│ │ │ ├── spaces.ts # スペーシング設定
181+
│ │ │ └── breakpoints.ts # ブレークポイント設定
182+
│ │ ├── styles/ # スタイル定義
183+
│ │ │ └── globals.css # グローバルスタイル
184+
│ │ └── global.ts # グローバルテーマ設定
113185
│ └── types/ # TypeScript 型定義
186+
├── .github/ # GitHub設定
187+
├── .yarn/ # Yarn設定
114188
├── biome.json # Biome 設定
115189
├── next.config.ts # Next.js 設定
190+
├── next-env.d.ts # Next.js型定義
116191
├── package.json # パッケージ設定
117-
└── tsconfig.json # TypeScript 設定
192+
├── tsconfig.json # TypeScript 設定
193+
├── tsconfig.tsbuildinfo # TypeScriptビルド情報
194+
├── .gitignore # Git除外設定
195+
├── .gitattributes # Git属性設定
196+
├── .yarnrc.yml # Yarn設定
197+
└── yarn.lock # Yarnロックファイル
118198
```
119199

120200
## 🤝 コントリビューション
@@ -135,3 +215,5 @@ toban-lp/
135215
- [TypeScript ドキュメント](https://www.typescriptlang.org/docs/)
136216
- [Emotion ドキュメント](https://emotion.sh/docs/introduction)
137217
- [Biome ドキュメント](https://biomejs.dev/)
218+
- [Storybook ドキュメント](https://storybook.js.org/docs/react/get-started/introduction)
219+
- [React Icons ドキュメント](https://react-icons.github.io/react-icons/)

next.config.ts

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,7 @@ const nextConfig: NextConfig = {
1313
},
1414

1515
env: {
16-
NEXT_PUBLIC_AIRTABLE_PAT: process.env.NEXT_PUBLIC_AIRTABLE_PAT,
17-
NEXT_PUBLIC_AIRTABLE_BASE: process.env.NEXT_PUBLIC_AIRTABLE_BASE,
18-
NEXT_PUBLIC_AIRTABLE_TABLE: process.env.NEXT_PUBLIC_AIRTABLE_TABLE,
16+
1917
},
2018
};
2119

package.json

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,20 @@
88
"build": "next build",
99
"export": "next build && next export",
1010
"start": "serve out",
11-
"lint": "yarn run biome lint ./src",
12-
"lint:fix": "yarn run biome lint ./src --write",
13-
"lint:fix:css": "stylelint --fix \"**/*.{js,jsx,ts,tsx}\"",
14-
"format": "yarn run biome format ./src --write",
15-
"check": "yarn run biome check ./src",
16-
"clean": "yarn run biome check ./src --write",
11+
"lint": "biome lint ./src",
12+
"lint:fix": "biome lint ./src --write",
13+
"format": "biome format ./src --write",
14+
"check": "biome check ./src",
15+
"check:fix": "biome check --write --unsafe ./src",
16+
"type-check": "tsc --noEmit",
1717
"build-storybook": "storybook build"
1818
},
1919
"dependencies": {
2020
"@emotion/react": "^11.0.0",
2121
"next": "^15.0.0",
2222
"react": "^18.0.0",
2323
"react-dom": "^18.0.0",
24+
"react-icons": "^5.5.0",
2425
"serve": "^14.0.0"
2526
},
2627
"devDependencies": {
@@ -31,6 +32,12 @@
3132
"lint-staged": "^15.0.0",
3233
"typescript": "^5.0.0"
3334
},
35+
"lint-staged": {
36+
"*.{js,jsx,ts,tsx}": [
37+
"biome check --write --unsafe ./src",
38+
"biome format --write ./src"
39+
]
40+
},
3441
"simple-git-hooks": {
3542
"pre-commit": "npx lint-staged"
3643
},
87.8 KB
Loading
173 KB
Loading
102 KB
Loading
48.6 KB
Loading
113 KB
Loading
89.9 KB
Loading

0 commit comments

Comments
 (0)