From f4b51fdad4a52f04e825f261760c954f5a8c772f Mon Sep 17 00:00:00 2001 From: MURAKAMI Masahiko Date: Fri, 11 Apr 2025 16:18:27 +0900 Subject: [PATCH 1/2] docs: Update README.md --- README.md | 92 ++++++++++++++----------------------------------------- 1 file changed, 23 insertions(+), 69 deletions(-) diff --git a/README.md b/README.md index e0d2066..4273f8d 100644 --- a/README.md +++ b/README.md @@ -1,100 +1,54 @@ -# Welcome to React Router! +# Agile Studio Talent Management System -A modern, production-ready template for building full-stack React applications using React Router. +このプロジェクトは Agile Studio のタレントマネジメントシステムです。 -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/remix-run/react-router-templates/tree/main/default) +## プロジェクト概要 -## Features +Agile Studio のメンバーのスキルや経験、プロジェクトアサイン状況などを管理するためのシステムです。React Router と AWS Amplify を使用して構築されています。 -- 🚀 Server-side rendering -- ⚡️ Hot Module Replacement (HMR) -- 📦 Asset bundling and optimization -- 🔄 Data loading and mutations -- 🔒 TypeScript by default -- 🎉 TailwindCSS for styling -- 📖 [React Router docs](https://reactrouter.com/) +## 開発環境セットアップ -## Getting Started +### 1. 依存関係のインストール -### Installation - -Install the dependencies: +プロジェクトのルートディレクトリで以下のコマンドを実行し、必要なパッケージをインストールします。 ```bash npm install ``` -### Development +### 2. 開発サーバーの起動 -Start the development server with HMR: +以下のコマンドで開発サーバーを起動します。ホットリロードが有効になります。 ```bash npm run dev ``` -Your application will be available at `http://localhost:5173`. +アプリケーションは `http://localhost:5173` で利用可能になります。 -## Building for Production +## ビルド -Create a production build: +本番用のビルドを作成するには、以下のコマンドを実行します。 ```bash npm run build ``` -## Deployment - -### Docker Deployment - -This template includes three Dockerfiles optimized for different package managers: +ビルド成果物は `build/` ディレクトリに出力されますが、Amplify Hosting でのデプロイ時には `amplify.yml` の設定に基づいて自動的にビルドが行われます。 -- `Dockerfile` - for npm -- `Dockerfile.pnpm` - for pnpm -- `Dockerfile.bun` - for bun +## デプロイ (AWS Amplify Hosting) -To build and run using Docker: - -```bash -# For npm -docker build -t my-app . - -# For pnpm -docker build -f Dockerfile.pnpm -t my-app . - -# For bun -docker build -f Dockerfile.bun -t my-app . - -# Run the container -docker run -p 3000:3000 my-app -``` - -The containerized application can be deployed to any platform that supports Docker, including: - -- AWS ECS -- Google Cloud Run -- Azure Container Apps -- Digital Ocean App Platform -- Fly.io -- Railway - -### DIY Deployment - -If you're familiar with deploying Node applications, the built-in app server is production-ready. - -Make sure to deploy the output of `npm run build` - -``` -├── package.json -├── package-lock.json (or pnpm-lock.yaml, or bun.lockb) -├── build/ -│ ├── client/ # Static assets -│ └── server/ # Server-side code -``` +このプロジェクトは AWS Amplify Hosting でのデプロイが推奨されます。 -## Styling +1. **AWS Amplify Console にアクセス:** AWS マネジメントコンソールから Amplify Console を開きます。 +2. **新しいアプリを作成:** 「ウェブアプリをホスト」を選択し、アプリ作成プロセスを開始します。 +3. **リポジトリを接続:** このプロジェクトのリポジトリ（例: GitHub, GitLab, Bitbucket）を Amplify に接続します。 +4. **ブランチを選択:** デプロイしたいブランチを選択します。 +5. **ビルド設定の確認:** Amplify はリポジトリ内の `amplify.yml` を自動的に検出し、ビルド設定を構成します。通常、追加の設定は不要です。 +6. **デプロイ:** 設定を確認し、デプロイを開始します。 -This template comes with [Tailwind CSS](https://tailwindcss.com/) already configured for a simple default starting experience. You can use whatever CSS framework you prefer. +デプロイが完了すると、Amplify によって提供される URL でアプリケーションにアクセスできるようになります。CI/CD パイプラインも自動的に設定され、選択したブランチへのプッシュをトリガーに自動でビルドとデプロイが実行されます。 --- -Built with ❤️ using React Router. +Built with ❤️ using React Router and AWS Amplify. From 6d03dd1118638167d80c42aabbe3e5fc7ab62e81 Mon Sep 17 00:00:00 2001 From: MURAKAMI Masahiko Date: Fri, 11 Apr 2025 17:38:48 +0900 Subject: [PATCH 2/2] docs: Update project description in README.md --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4273f8d..c8b7f07 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # Agile Studio Talent Management System -このプロジェクトは Agile Studio のタレントマネジメントシステムです。 +Devinを導入して作成したWebアプリケーション（Agile Studio のタレントマネジメントシステム）のリポジトリです。 + +[AIプログラマー「Devin」と挑む新たな開発の可能性 ～ アジャイル開発との親和性](https://www.agile-studio.jp/post/challenge-new-development-with-devin) で紹介しています。 ## プロジェクト概要