From b25bd636af09e30f608a67d896454412ccf9e2dc Mon Sep 17 00:00:00 2001
From: koumura <komura.masahiro@a-tm.co.jp>
Date: Wed, 31 Jul 2024 21:48:47 +0900
Subject: [PATCH] fix: README

---
 README.md | 60 +++++++++++++++++++++++++++++++++----------------------
 1 file changed, 36 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index ecb40c5..100304e 100644
--- a/README.md
+++ b/README.md
@@ -1,41 +1,53 @@
-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).
+# RESAS Graph App - 都道府県ごとの人口遷移グラフ表示アプリ
 
-## Getting Started
+## 作成したアプリケーション
 
-Create .env.local directly under the root directory and .
-Write NEXT_PUBLIC_RESAS_API_KEY
+- https://yumemi-test-chart.vercel.app/
 
-```.env.local
-NEXT_PUBLIC_RESAS_API_KEY=
-```
-
-```bash
-npm run dev
-```
+## 開発
 
-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.
+| カテゴリ                  | 名前                                  |
+| ------------------------- | ------------------------------------- |
+| Web Application Framework | Next.js                               |
+| UI Library                | React                                 |
+| Programming Language      | TypeScript                            |
+| Chart Library             | Highcharts                            |
+| Styling                   | CSS                                   |
+| Package Manager           | npm                                   |
 
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
 
-## Learn More
+### 環境構築
 
-To learn more about Next.js, take a look at the following resources:
+#### RESAS API から API Key を取得
 
-- [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.
+- RESAS API に登録し、API Key の取得が必要
 
-You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+- .env.local を作成し、取得した API Key をセットする
 
-## Deploy on Vercel
+```bash
+NEXT_PUBLIC_RESAS_API_KEY=(取得した API Key)
+```
 
-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.
+#### RESAS API 概要
 
-Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
+```
+https://opendata.resas-portal.go.jp/docs/api/v1/index.html
+```
 
+#### ライブラリ の インストール
 
-## RESAS API
+```bash
+$ npm install
 ```
-https://opendata.resas-portal.go.jp/docs/api/v1/index.html
+
+#### 開発サーバ の 起動
+
+```bash
+$ npm run dev
 ```
+
+#### ブラウザ で 表示確認
+
+- localhost:3000