まず、プロジェクトはyarnをパッケージインストール用に使用しています。yarnを自身でインストールしてください。インストール完了後、yarn set version v1.22.19コマンドでバージョンを設定します。
次に、'Geese'プロジェクトをローカルで実行するには、以下の手順に従ってください:
- プロジェクトのクローン:
git clone git@github.com:HelloGitHub-Team/geese.git - 依存関係のインストール:
yarn install - プロジェクトの実行:
yarn dev - ブラウザでアクセス:
http://localhost:3000/
起動後に遭遇する可能性のある問題:
- CORS問題: フロントエンドサービスがポート
3000で、ホストがlocalhostまたは127.0.0.1で起動していることを確認してください。 - 画像が表示されない: ローカルのhostsファイルの末尾に
127.0.0.1 dev.hg.comを追加し、http://dev.hg.com:3000/でアクセスしてください。 - ログイン状態: @521xueweihanからテスト環境のログイントークンを取得し、ブラウザのLocalStorageにAuthorization: tokenアイテムを手動で追加してください。
- ビルド中にマシンがフリーズする場合: yarnで同時実行数を設定することで解決できます:
yarn config set cloneConcurrency 1
技術スタック
- Next.js
- Tailwind CSS
- SWR
- スキャフォールド: ts-nextjs-tailwind-starter
- コンポーネントスタイル: hyperui
最後に、APIドキュメントはこちらで確認できます。
プロジェクトを実行できたら、ローカルで試してみてください。興味を持った場合は、こちらをクリックして未割り当ての要件を確認し、興味のある機能、バグ、または最適化を見つけ、開発を始める前に対応するissuesで@521xueweihanに「タスクを引き受けます」と伝えて、重複開発を防いでください。
これは共同開発であるため、mainブランチは継続的に更新される可能性があります。各開発セッションの前に、最新のコードをプルして、最新のmainブランチに基づいて開発していることを確認する必要があります。
特定の要件を開発する際は、コードを対応するディレクトリに分割してください:
- コンポーネント:
componentsディレクトリ - ページ:
pagesディレクトリ - データ定義:
typesディレクトリ - リクエスト:
servicesディレクトリ
機能開発/バグ修正の完了後、セルフテスト、コードスタイルのチェック、コードの再利用性の向上を行う必要があります。
最後に、以下のコマンドをローカルで実行し、可能な限り警告を解決してください:
yarn lint:fixyarn lintyarn typecheck
最新のmainブランチコードを取得し、ローカルで競合を解決してください。
最初のコード提出は、PR(Pull Request)を通じて行う必要があります。
コードが正常にマージされた後、@521xueweihanが'Geese'プロジェクトのメンバーとして招待します。GitHubの通知メールを確認してください。
その後のコード提出は、'自己作成ブランチ'または'要件の引き受け時に自動作成されるブランチ'で開発できます。
コードを提出した後は、プロジェクトのissuesとprsの通知に注意を払ってください。提出されたコードをレビューした後、フィードバックと最適化の提案を提供します。
皆さんと'Geese'を構築できることを嬉しく思います。コード貢献のプロセスから何かを得ていただければ幸いです。