From 308ac34edbee63ec8168becf789b572fe818da5e Mon Sep 17 00:00:00 2001 From: Uchida Date: Sun, 17 Nov 2024 13:29:21 +0000 Subject: [PATCH] =?UTF-8?q?README.md=E3=81=AE=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/deploy_main.yml | 4 +- README.md | 132 +++++++++++++----------------- 2 files changed, 59 insertions(+), 77 deletions(-) diff --git a/.github/workflows/deploy_main.yml b/.github/workflows/deploy_main.yml index ef20100..bc4bc80 100644 --- a/.github/workflows/deploy_main.yml +++ b/.github/workflows/deploy_main.yml @@ -1,7 +1,7 @@ name: mainブランチの内容をもとにAPIから事前にデータを取得しCloudflare Pagesにデプロイ on: - # schedule: - # - cron: '0 15 * * *' # 毎日0時(日本時間)にビルド + schedule: + - cron: "0 15 * * *" # 毎日0時(日本時間)にビルド workflow_dispatch: push: branches: diff --git a/README.md b/README.md index 25b5821..26ab6b4 100755 --- a/README.md +++ b/README.md @@ -1,75 +1,57 @@ -# Nuxt Minimal Starter - -Look at the [Nuxt documentation](https://nuxt.com/docs/getting-started/introduction) to learn more. - -## Setup - -Make sure to install dependencies: - -```bash -# npm -npm install - -# pnpm -pnpm install - -# yarn -yarn install - -# bun -bun install -``` - -## Development Server - -Start the development server on `http://localhost:3000`: - -```bash -# npm -npm run dev - -# pnpm -pnpm dev - -# yarn -yarn dev - -# bun -bun run dev -``` - -## Production - -Build the application for production: - -```bash -# npm -npm run build - -# pnpm -pnpm build - -# yarn -yarn build - -# bun -bun run build -``` - -Locally preview production build: - -```bash -# npm -npm run preview - -# pnpm -pnpm preview - -# yarn -yarn preview - -# bun -bun run preview -``` - -Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information. +# 2025 quaint app +## 伝言 +Nuxt3(フロントフレームワーク) +Vuetify(UIフレームワーク) +yarn(パッケージマネージャー) +→npmを使わないように気をつけて +eslint(developとmainにマージするようにチェックするようにgithub actionでworkflowを組んでおいた) +本当はcommitしたときにeslintのチェックいれるべきだと思うけどhuskyがnot in a git repositoryとかでて面倒だったので断念 +こだわりがあったら後々直してください、、 +prettier +→ファイル保存時にeslintとprettierは実行するようにした気がする +sidebase-nuxt-auth(認証用モジュール) +→パッケージをインストールしただけでセットアップしてないです + +devcontainerとdocker composeの両方使えるようにしてあります +docker compose でコンテナ立ち上げるときはcloneして最初に起動するときはyarn installをするのを忘れないで。 +→devcontainerのほうはコンテナ作成と同時にyarn installを自動でするようになってます + +＜フォルダ解説＞ +.github : github actionのworkflowが入ってます +.vscode : vscodeの設定と推薦する拡張機能を書いておきました。このリポジトリ開くと右下あたりにポップアップがでてくるはず +pages : nuxt2と同じ。フロントのいわゆるメインとなる部分です。.vueファイルを入れていくことになる +plugins : pluginの設定ようです。vuetifyを入れるためのファイルがあるのがわかると思います。 +.node-version : nodeのバージョン書いてます。cloudflare pagesでデプロイするときにnodeのバージョン指定してもなんかうまく認識してくれなかったのでここにファイルとしておいてあります。 +.prettierignore : prettierがコード整形しないファイルを記述する場所 +.prettierrc : prettierの設定ファイル。好きなようにカスタマイズして +eslint.config.js : eslintの設定ファイル。自分で一からやるの面倒だったから適当なテンプレート読み込んであります。変数命名規則ぐらいは自分で作ったほうがいいよ +nuxt.config.ts : nuxt3の設定が書いてあるファイルです +package.json : モジュールの依存関係とか色々。詳しくは調べて +tsconfig.json : 調べてないから知らん。多分typescriptの設定を書いていく場所 +yarn.lock : yarnが勝手に書いていく場所です。人の手で絶対に編集しないようにして + +＜デプロイに関して＞ +mainブランチの内容が毎日0時とpushされたときに自動でデプロイするようにしたはず。時間なさすぎて何も確認してないからエラー出るかも。少なくとも技術主任の人はcloudflare使って手動でデプロイする権限あるので自動でできてなかったら、組み直すか手でやってください。cloudflareのデプロイの設定はすでにしてあります + +## ブランチの使い分け +main : 本番のコードをおいておく +develop : 開発用のコードをおいておく +その他 : 新しい機能を開発する + +ということでつまり +1 developから新しくブランチを作って新しい機能を開発 +2 developに新しい機能を作ったブランチをマージ +3 develop → main にマージ +という流れに統一してください + +eslintとcloudflareのチェックがpull requestを作ると自動で行われるようになってます。よく確認してからマージしてください。 + +## これからやること +nuxt3用の認証モジュールはsidebase-nuxt-authを入れておきました。 +これにした理由は推奨されていた３つのモジュールの中で一番有名だったから + +moduleとしてnuxtにこのライブラリ読み込ませると、他のセットアップまで色々やるまでページが正しく動かなくなっちゃうっぽかったから、ライブラリインストールしただけでそれ以外のセットアップは僕は何もやってないです（セットアップまで全部やろうとするには時間がなさすぎた、すみません、、、、）。nuxt.config.tsのmoduleの欄を見ると僕がmoduleのsidebase-nuxt-authのインポートをコメントアウトしている部分が見つかると思います。 + +ということで一番はじめにやる必要があるのはこれのセットアップだと思います（整理券取るのにログイン正しくできなかったら大問題）。 + +みんな協力して頑張って！！ \ No newline at end of file