/yumemi-fe-coding-test

Frontend For coding test of Yumemi Co.

Primary LanguageTypeScript

都道府県別の総人口推移グラフ

デプロイ済みURL

概要

株式会社ゆめみ様のフロントエンドコーディング試験の課題

都道府県別の総人口推移グラフを表示するSPA(Single Page Application)

開発環境

Vercelにデプロイしているため、Vercelのプロジェクトを作成する必要がある

環境変数の設定

変数名 説明 値
VITE_API_BASE_URL Vercel Serverless FunctionにデプロイされたURLを指定 Developmentにはhttp://localhost:3000を指定。ProductionはProduction環境のURLを指定。
RESAS_API_ENDPOINT RESAS APIのエンドポイントを指定。 https://opendata.resas-portal.go.jp
RESAS_API_KEY RESAS APIのAPIキー RESAS公式ページより取得

Vercelから環境変数をインポート

pnpm prepare-env

ローカル環境立ち上げ

pnpm start

内部でvercel devを実行している

エンドポイントは[http://localhost:3000/]でアクセス可能 api配下のエンドポイントはhttp://localhost:3000/api/hogeでアクセス可能

ビルド

pnpm build

ESLint

pnpm lint

テスト

watchモードでテストを実行 pnpm test

CI内では下記を実行 pnpm test:run

API仕様

都道府県一覧取得

Request

GET /api/getPrefectures

Response

type APIResponse = {
  prefCode: string
  prefName: string
}[]

都道府県別の総人口推移取得

Request

GET /api/getPopulationComposition

パラメータ名 必須 型 説明
prefCode ○ 文字列 都道府県コード

Response

type APIResponse = {
  prefCode: string
  data?: {
    year: number
    value: number
  }[]
}