Merge pull request #9 from kstm-su/feat/add-how-to-check-api-docs

README.mdの加筆修正

README.md

@@ -1,41 +1,32 @@
 # member-portal
 kstmメンバーであることを確認し、また事務処理を簡潔化するためのポータルサイト
 
-以下Next.jsのREADME.md
----
-This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+## Frontend
+### Docker起動方法
+1. Dockerfileのあるディレクトリに移動
+2. `docker build -t <image_name> .` を実行（image_nameは自由に設定）
+3. `docker run -p 3000:3000 -d <image_name>` を実行
+4. `http://localhost:3000` にアクセス
 
-## Getting Started
+※ ローカルで起動する場合は、`npm run dev` を実行
 
-First, run the development server:
+## Backend 
 
-```bash
-npm run dev
-# or
-yarn dev
-# or
-pnpm dev
-# or
-bun dev
-```
+### Docker起動方法
+1. Dockerfileのあるディレクトリに移動
+2. `docker build -t <image_name> .` を実行（image_nameは自由に設定）
+3. `docker run -p 3001:8080 -d <image_name>` を実行
+4. `http://localhost:3001` にアクセス
 
-Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
 
-You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+## Common
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+### APIドキュメント確認方法
+1. `cd swagger`で`swagger`ディレクトリに移動します
+2. `npx @redocly/cli preview-docs documentation.yml`を実行します
+3. `http://localhost:8080/`にアクセス
 
-## Learn More
-
-To learn more about Next.js, take a look at the following resources:
-
-- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
-- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
-
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
-
-## Deploy on Vercel
-
-The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
-
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+### Mockサーバーの立て方
+1. `swagger/README.md` の "Getting started" の手順を行う
+2. "Mock API" の手順を `documentation.yml` と同じディレクトリにて行う
+3. `http://localhost:4010`にモックサーバーが立つ

member-portal-backend/clients/example_client.json

@@ -0,0 +1,6 @@
+{
+  "clientId": "example_client",
+  "clientName": "Example Client",
+  "redirectUri": "http://localhost:3000/callback",
+  "applicationName": "Example Application"
+}

member-portal-frontend/Dockerfile

@@ -5,7 +5,7 @@ WORKDIR /app
 COPY ./package*.json ./
 
 RUN npm install
-
+EXPOSE 3000
 COPY . .
 
 ENTRYPOINT ["npm", "run", "dev"]