Skip to content

Commit

Permalink
Merge pull request #284 from nekochans/feature/issue283/move-componen…
Browse files Browse the repository at this point in the history
…t-from-lgtm-cat-ui

lgtm-cat-ui のComponentを移行
  • Loading branch information
keitakn authored Feb 15, 2024
2 parents a20346a + a2897c9 commit b9d862c
Show file tree
Hide file tree
Showing 182 changed files with 5,597 additions and 378 deletions.
6 changes: 3 additions & 3 deletions .github/workflows/chromatic.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ jobs:
timeout-minutes: 10
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Install dependencies
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: 18
node-version: 20
registry-url: 'https://npm.pkg.github.com'
cache: 'npm'
scope: '@nekochans'
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ jobs:
timeout-minutes: 10
strategy:
matrix:
node-version: [18.x]
node-version: [20.x]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Use Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
cache: 'npm'
Expand All @@ -33,6 +33,6 @@ jobs:
NEXT_PUBLIC_LGTMEOW_BFF_URL: ${{ secrets.NEXT_PUBLIC_LGTMEOW_BFF_URL }}
NODE_AUTH_TOKEN: ${{ secrets.AUTH_TOKEN_FOR_GITHUB_PACKAGES }}
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v2
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
1 change: 1 addition & 0 deletions .storybook/main.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ const config: StorybookConfig = {
'@storybook/addon-essentials',
'@storybook/addon-onboarding',
'@storybook/addon-interactions',
'@storybook/addon-a11y',
],
framework: {
name: '@storybook/nextjs',
Expand Down
3 changes: 3 additions & 0 deletions .storybook/preview.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import 'ress/ress.css';
import '../src/styles/markdown.css';
import '../src/styles/globals.css';
import { INITIAL_VIEWPORTS } from '@storybook/addon-viewport';
import type { Preview } from '@storybook/react';
import { initialize, mswDecorator } from 'msw-storybook-addon';
Expand Down
34 changes: 4 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ lgtm-cat(サービス名 LGTMeow https://lgtmeow.com のフロントエンド

## 環境変数の設定

`.env`を作成し、下記を設定してください。
`.env.local`を作成し、下記を設定してください。

数がそれなりに多いので `vercel env pull .env` で環境変数をダウンロードするのがオススメです。
数がそれなりに多いので `vercel env pull .env.local` で環境変数をダウンロードするのがオススメです。

https://vercel.com/docs/cli#commands/dev/when-to-use-this-command

Expand All @@ -28,24 +28,17 @@ NEXT_PUBLIC_LGTMEOW_BFF_URL=https://github.com/nekochans/lgtm-cat-bff が稼働
EDGE_CONFIG=Vercel Edge ConfigのURL(Vercel上の値を参照)
```

以下の環境変数はテストコード実行時や Build 時に参照されるので [direnv](https://github.com/direnv/direnv) を使って `.envrc` を配置するのが良いです
ローカルでSentryやChromaticの動作確認を実施する場合 [direnv](https://github.com/direnv/direnv) を使って `.envrc` に以下の環境変数を設定します

```
export NEXT_PUBLIC_LGTMEOW_BFF_URL=https://github.com/nekochans/lgtm-cat-bff が稼働しているURLを指定
export CHROMATIC_PROJECT_TOKEN=Chromaticのトークンを指定
export NEXT_PUBLIC_APP_ENV=local
export NEXT_PUBLIC_APP_URL=http://localhost:2222
export NEXT_PUBLIC_LGTMEOW_BFF_URL=https://github.com/nekochans/lgtm-cat-bff が稼働しているURLを指定
export CHROMATIC_PROJECT_TOKEN=Chromaticのトークンを指定
export SENTRY_ORG=Sentryの組織を指定(Vercel上の値を参照)
export SENTRY_PROJECT=Sentryのプロジェクト名(Vercel上の値を参照)
export NEXT_PUBLIC_SENTRY_DSN=SentryのDNS(Vercel上の値を参照)
export SENTRY_AUTH_TOKEN=Sentryのトークン(Vercel上の値を参照)
```

以下の環境変数はなくてもテストが通りますが、Mock Service Worker に渡す URL が `undefined` になる為、Mock 周りで何かトラブルがあった際にデバッグの妨げになる可能性があるので設定しておくのが無難です。

- `NEXT_PUBLIC_LGTMEOW_BFF_URL`

`CHROMATIC_PROJECT_TOKEN` に関しては `npm run chromatic` を利用しない限りは設定不要です。

以下の環境変数は Sentry の初期化に必須です。
Expand All @@ -56,25 +49,6 @@ export SENTRY_AUTH_TOKEN=Sentryのトークン(Vercel上の値を参照)
- `NEXT_PUBLIC_SENTRY_DSN`
- `SENTRY_AUTH_TOKEN`

## `.npmrc` の追加

GitHub Packages 内の private package を利用しているので、プロジェクトルートに `.npmrc` が必要です。

[こちら](https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) を参考に Personal Access Token を発行します。

権限は `read:packages` があれば問題ありません。以下は作成例です。

![personal-access-token](https://user-images.githubusercontent.com/11032365/189850906-6008cb05-1705-409f-beec-4910f9175c90.jpg)

Personal Access Token を発行したら以下の内容で`.npmrc` を作成します。

`ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` の部分は発行した Personal Access Token に置き換えて下さい。

```
@nekochans:registry=https://npm.pkg.github.com
//npm.pkg.github.com/:_authToken=ghp_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```

## Node.js のインストール

20 系の最新を利用して下さい。
Expand Down
Loading

0 comments on commit b9d862c

Please sign in to comment.