DMM WEBCAMPAdvent Calendar 2023

【Next.js×microCMS×Vercel】初心者向け爆速ブログ作成ハンズオン

Last updated at 2024-08-05Posted at 2023-12-21

はじめに

DMM WEBCAMPのAdvent Calendarの 22 日目の担当することになりました、@takakouと申します🏙️✨

今回は、【 Next.js×MicroCMS×Vercel 】初心者向け爆速ブログ作成ハンズオン」というテーマで記事をシェアします🚀

初心者向けなので、緩く解説しながら進めていこうと思っています👍

文章がかなり長くなってしまうかもしれませんが、事前知識がある方は飛ばし飛ばしみていただけますと幸いです📚

こちらにも同時掲載しています・

1. 対象者

今回の記事の対象者となるのは下記の方々です。

Next.jsとmicroCMSを用いて無料でブログを作ってみたい方々
WordPress や STUDIO などの今時の便利ツールを使いたくない僕のような逆張りの方々
無料でブログやPF掲載用のサイトを作成したい方々
わからないことは自分で調べられる人方々

POINT
わからないことがあった場合はchatGPTやBing AIに聞いてもらってもちろん問題ありません。しかしブラウジング機能を利用しないとNext13系の情報を参照してくれなかったりするので気をつけてください。

ATTENTION
今回はHobbyプランという無料プランを用いるため、このままでは将来的に広告をつけられません。もし広告収益を狙っている方がいらっしゃったら、課金をするか、もしくは他のデプロイ先を今後検討する必要があることを頭の片隅に置いておいていただけると幸いです。

2. 動作環境

この章では動作環境についてまとめておきます。

端末

PC : MacBook Air(M1,2020)
RAM : 8GB
OS : macOS Monterey(ver12.1)

実行環境

Node.js: ver.18以降

3. 技術選定

この章では技術選定についてまとめておきます。

フロントエンド

Language: TypeScript5.0
Library: React18
FW: Next.js13.5(App routerを採用)

ページを表示するならReactだけでもいいのですが、今回はNext.jsを採用しました。なのでメリット、デメリットについてまとめておきます。
(Vue,Nuxtを使わなかったのは、単純に自分が使ったことがないだけです。😢)

メリット

事前にHTMLを生成し、それをリクエストとして返すことができるので、パフォーマンスの向上が見込める。
SPAと違いSEOに強い。(諸説あります。今はクローラがSPAも正しくページを認識してくれるらしい？)

デメリット

常に最新の状態を表示できるわけではないこと。(SSGでサイトを動的ではなく静的サイトにしていた場合の話)

この記事の求めるところは本質理解ではないので、理解を深めたい方は以下の記事で、SSGやSPAについての理解を深めることをお勧めいたします。すごくわかりやすかったです！

CMS

CMS: microCMS

CMSとは何で、microCMSとはどのようなサービスなのかをまとめておきます。

CMSとは

「CMS」とは、「Contents Management System：コンテンツ・マネジメント・システム」の略で、簡単にいうとWebサイトのコンテンツを構成するテキストや画像、デザイン・レイアウト情報（テンプレート）などを一元的に保存・管理するシステムのことです。(参照元)

語弊を生むかもしれませんがめちゃくちゃ簡単に言うと、データを保存しておく、DBの処理などのバックエンド側の処理をまとめてやってくれるシステムですね。

microCMSとは

誰でも使いやすいことを目標にして開発された日本製ヘッドレスCMSで、直感的に入稿できるシステムによってあらゆる編集者にもわかりやすく、さまざまな要件にも適応できます。

今回選んだ大きな理由としては、クレジットカードなしで使えるので、まずは、使ってみたい初心者に対しての使用のハードルが低いことです。あとリファレンスが日本語なのとコミュニティが存在していることが大きいです。Discordのコミュニティを覗いていると、かなり盛んにユーザから運営に向けての質問が起票されており、運営も誠実に対応している様子が見受けられます。もしもの時にとても心強いですね。

CSS

TailwindCSS

TailswindCSSについても簡単にまとめておきます。

TailwindCSSとは

TailwindCSSは、ユーティリティクラス(utility class)を自由に組み合わせて活用することで、オリジナリティの高いデザインのWebサイト及びWebアプリケーションを作成可能なCSSフレームワークです。

選んだ理由は単純で、Next.jsのプロジェクトに導入するのがすごく簡単だからです。(コードが汚くなるので個人的にはあまり好きではないですが...)

デプロイ

Service: Vercel

Vercelについてもどのようなサービスなのか説明をまとめておきます。

Vercelとは

VercelはCI/CDとWebサーバーが合わさったサービスです。無料で始めることができ、GitHubなどのリポジトリと連携することで手軽にアプリケーションをデプロイすることが可能です。また、CDNが含まれているため高速なページ表示が可能となっています。(参照元)

個人的には気軽にNext.jsプロジェクトをデプロイするならVercelかなって思ってます。
あと、最初に注意書きで書いてますが、使うプランはHobbyなので収入を得るような使い方はできません。有料プランにするか、他のデプロイ先を検討してみてください。(Amplifyやcloudflare pagesが気になってる。)

4. 実装手順

この章では実装手順について説明をしていきます。

プロジェクト作成

プロジェクト名はなんでも良いですが、この記事では「my-tech-blog」としておきます。
プロジェクト内は、メインでTypescriptを使いたいのでオプションを指定しておきます。

Terminal

~ $ npx create-next-app my-tech-blog --typescript

作成時にオプションの設定が出てきますが以下のように設定していただければと思います。

それでは一旦プロジェクトが立ち上がるの確認だけしておきましょう。

Terminal

~ $ cd my-tech-blog
~ my-tech-blog $ npm run dev

起動ができたら下記のURLにアクセスしてください。

にアクセスし、下記のような画面になっていたらプロジェクトの起動に成功しています。

ATTENTION
人によってはこちらのエラーが出るかもしれません。

[Error: EACCES: permission denied, mkdir '/~/my-tech-blog/.next'] {
  errno: -13,
  code: 'EACCES',
  syscall: 'mkdir',
  path: '/~/my-tech-blog/.next'
}

プロジェクトの操作をするのに、権限的に問題があることを示しているので、下記のコマンドを実行してください。

~ $ sudo chmod -R 777 .

microCMSの設定

下記のURLにアクセスをしてmicroCMSのコンテンツ管理画面にアクセスしてください。
アカウントがない方は適当にアカウントを作成してください。

下記の画面まで進んだら「一から作成する」を選びましょう。
ここも便利な方を選ばないという逆張り精神を大切にしていきます。

次の画面に進んだら、「サービス名」、「サービスID」を好きなように入力をしてみましょう。
「サービス名」は最初に作成したプロジェクト名と一緒にしておくとわかりやすいのでお勧めですが、「サービスID」は他の誰かと同じIDになってはいけないのでダメと言われたら適当に変更しましょう。

成功したらこんな画面が出てくるので、一旦喜んでお茶を飲みましょう。
休憩をしたところで「サービスにアクセスする」をクリックして進みましょう。

こんな画面に進むと思います。
そうしたら早速APIを作成していくのですが、
ここも逆張り精神を大切にし、「自分で決める」をクリックしましょう。

するとこちらの画面に進みます。
サービス名を「ブログ」、エンドポイントを「blogs」にしておきます。
内容を別に自分と一緒じゃなくても問題ないです。
入力が終わったら次のページに進みましょう。

ここは「リスト形式」を選択しておきましょう。
問題なければ次のページに進みましょう。

最後はこのページになります。
スキーマとして「title」,[body]を定義しておきます。
本当ならカテゴリや、タグも追加すべきなのですが、やることが増えるので今回の記事では割愛します。
入力が終わったら「作成」ボタンを押しましょう。

終わったらこのページに進めば問題なしです。
ではここからテストデータとして、ブログをいくつか追加していきましょう。
「追加」のボタンを押して、次のページに進みましょう。

このようにデータの追加画面に進みます。
リッチテキストエディアはslackやmattermostのテキスト入力欄のように、割と直感的に使えるので、色々触ってみると良いと思います。
早速ですが、タイトル、本文を適当に埋めてみましょう。

こんな感じでデータをいくつか作っていきます。
入力し終わるたびに右上の「公開」ボタンを押せば良いです。

左上に「公開中」と出ていれば問題ないです。

このまま本文を変更すると、さっき作成した一つ目のブログを上書きしていくだけになってしまうので、二つ目のブログを作成するのに左のサイドバーの「コンテンツ」の下にある「ブログ」ボタンを押してブログのTOPページに戻ります。

ブログのTOPページに戻れたら右上の「追加」ボタンを押し、再度データを作成しにいきます。

データをいくつか追加した状態で、ブログのTO P画面に戻り、追加したデータが表示されていればOKです。

API_KEYの設定

APIリクエストをするときのAPI_KEYをNext.jsプロジェクトに設定していきます。

まずはAPI_KEYをmicroCMSのコンテンツ管理画面から確認します。
左のサイドバーの「APIキー」から確認することができます。

プロジェクトのルートディレクトリに.env.localというファイルを作成してください。
中身に下記の記述を追加します。
SERVICE_DOMAINはAPIを作成するときに決めたドメイン名を、API_KEYは、先ほど確認したものを追加してください。

.env.local

SERVICE_DOMAIN=xxxxxxxxxxxx
API_KEY=xxxxxxxxxxxx

ATTENTION
envファイルで設定したAPI_KEYは今回のSSGを採用したプロジェクトではprocess.env.API_KEYで呼び出すことができますが、CSRを採用しているプロジェクトの場合は頭にNEXT_PUBLIC_を追加する必要がある場合があります。(使用場面によります。)

.env.local

NEXT_PUBLIC_SERVICE_DOMAIN=xxxxxxxxxxxx
NEXT_PUBLIC_API_KEY=xxxxxxxxxxxx

microcms-js-sdkの準備

microcms-js-sdkをinstallします。

~ my-tech-blog $ npm install --save microcms-js-sdk

次に、ルートディレクトリにlibsフォルダを作成、その配下にclient.tsファイルを作成します。
今回はTypescriptを採用しているので、存在チェックを先に行います。
一覧取得と詳細取得用の処理も書いておきます。

libs/client.ts

import { createClient } from 'microcms-js-sdk';

export type Blog = {
    id: string;
    title: string;
    body: string;   
}

if (!process.env.SERVICE_DOMAIN) {
    throw new Error("MICROCMS_SERVICE_DOMAIN is required");
}

if (!process.env.API_KEY) {
    throw new Error("MICROCMS_SERVICE_DOMAIN is required");
}

export const client = createClient({
    serviceDomain: process.env.SERVICE_DOMAIN,
    apiKey: process.env.API_KEY,
});

// ブログ一覧を取得
export const getBlogs = async () => {
    const blogs = await client.getList<Blog>({
    endpoint: "blogs"
    });
    return blogs;
}

// ブログの詳細を取得
export const getDetail = async (contentId: string) => {
    const blog = await client.getListDetail<Blog>({
        endpoint: "blogs",
        contentId,
    });
    return blog;
};

ブログ一覧を表示

src/appディレクトリ配下にblogsフォルダを作成し、その配下にpage.tsxを作成します。

src/app/blogs/page.tsx

import Link from "next/link";
import { getBlogs } from "@/../libs/client";

export default async function StaticPage() {
    const { contents }  = await getBlogs();
  
    if (!contents) {
      return <h1>No Contents</h1>;
    }
  
    return (
      <>
        <div>
            <ul>
                {contents.map((blog) => (
                <li key={blog.id}>
                    <Link href={`/blog/${blog.id}`}>{blog.title}</Link>
                </li>
                ))}
            </ul>
        </div>
      </>
    );
  }
}

プロジェクトを起動し、確認します。

~ my-tech-blog $ npm run dev

下記のURLにアクセスします。

こんな感じで。自分が入力しておいたコンテンツのタイトルが出力されていたら、問題ないです。

ブログ詳細を表示

src/app/blogsディレクトリ配下に[blogId]フォルダを作成、その配下にpage.tsxを作成します。

src/app/blogs/[blogId]/page.tsx

import { getDetail,getBlogs } from "@/../libs/client";
import Link from "next/link"

export async function generateStaticParams(){
  const { contents } = await getBlogs();

  const paths = contents.map((blog)=>{
    return {
      blogId: blog.id,
    };
  });
  return [...paths];
}

export default async function StaticDetailPage({
  params : { blogId },
}: {
  params: { blogId : string};
}) {
  const blog = await getDetail(blogId);

  return(
    <>
        <p>{blog.title}</p>
        <div
          dangerouslySetInnerHTML={{
            __html: `${blog.body}`,
          }}
        />
    </>
  )
}

プロジェクトを起動している状態で、下記のURLにアクセスし、ブログのタイトルをクリックして、詳細の画面を表示してみましょう。

このように表示されていれば問題ないです。

レイアウトを整える

CSS

取得したHTML(blog.body)は任意のclassやstyleをmicroCMS側でつけることができないので、こちらでCSSを追加して対応します。
どうせならダークモードにも対応しようと思い、最近拝見したこちらの記事に影響されてデザイントークンを採用しています。

global.css

@tailwind base;
@tailwind components;
@tailwind utilities;

:root {
  --foreground-rgb: 28, 28, 28;
  --background-start-rgb: 245, 245, 245;
  --background-end-rgb: 255, 255, 255;
}

@media (prefers-color-scheme: dark) {
  :root {
    --foreground-rgb: 227, 227, 227;
    --background-start-rgb: 28, 28, 28;
    --background-end-rgb: 38, 38, 38;
  }
}

body {
  color: rgb(var(--foreground-rgb));
  background: linear-gradient(
      to bottom,
      transparent,
      rgb(var(--background-end-rgb))
    )
    rgb(var(--background-start-rgb));
}

.content h1 {
  @apply text-4xl font-bold mb-4 mt-8;
}

.content h2 {
  @apply text-3xl font-semibold mb-4 mt-6;
}

.content h3 {
  @apply text-2xl font-semibold mb-4 mt-5;
}

.content h4 {
  @apply text-xl font-semibold mb-3 mt-4;
}

.content {
  max-width: 800px;
  margin: 0 auto;
  padding: 20px;
  background-color: rgb(var(--background-end-rgb));
  border-radius: 8px;
  box-shadow: 0 0 10px rgba(0, 0, 0, 0.1);
  color: rgb(var(--foreground-rgb));
}

.content p {
  font-size: 18px;
  line-height: 1.6;
  color: #333333;
}

.content h1, .content h2, .content h3, .content h4, .content h5, .content h6, .content p {
  color: rgb(var(--foreground-rgb));
}

一覧画面

src/app/blogs/page.tsx

import Link from "next/link";
import { getBlogs } from "@/../libs/client";

export default async function StaticPage() {
    const { contents }  = await getBlogs();
  
    if (!contents) {
      return <h1 className="text-2xl font-bold text-center mt-20">No Contents</h1>;
    }
  
    return (
      <>
       <div className="h-screen container mx-auto mt-10">
            <ul className="space-y-10">
                {contents.map((blog) => (
                 <li key={blog.id} className="p-5 rounded shadow-lg content flex justify-between items-center">
                    <h4>
                        {blog.title}
                    </h4>
                    <Link href={`/blogs/${blog.id}`}>
                        <button className="px-4 py-2 bg-blue-500 text-white rounded hover:bg-blue-700 transition">
                            詳細
                        </button>
                    </Link>
                  </li>
                ))}
            </ul>
        </div>
      </>
    );
  }

詳細画面

src/app/blogs/[id]/page.tsx

import { getDetail,getBlogs } from "@/../libs/client";
export async function generateStaticParams(){
  const { contents } = await getBlogs();

  const paths = contents.map((blog)=>{
    return {
      blogId: blog.id,
    };
  });
  return [...paths];
}

export default async function StaticDetailPage({
  params : { blogId },
}: {
  params: { blogId : string};
}) {
  const blog = await getDetail(blogId);

  return(
    <>
      <div className="h-screen pt-5">
        <div className="content">
          <h1>{blog.title}</h1>
          <div
            dangerouslySetInnerHTML={{
              __html: `${blog.body}`,
            }}
          />
        </div>
      </div>
    </>
  )
}

確認

ライトモードとダークモードでそれぞれ実験してみます。

ライトモード
ダークモード

問題なく表示できていたら良いと思います。
ここは個人で自由にCSSやclassを変えてしまって問題ないので遊んでみてください。
うまく実行できなかった方は、下記のリポジトリを見て修正いただくか、cloneしてもらっても問題ありません。

デプロイ

ここからVercelにプロジェクトをデプロイしていきます。

githubリポジトリを作成

下記のURLにアクセスしてgithubリポジトリを作成してください。
作成が終わったらターミナルで下記のコマンドを順番に入力していきます。
${your-repository}の部分は自身で書き換えてください。(${}もちゃんと消してください。)

Terminal

~ my-tech-blog $ git init
~ my-tech-blog $ git add .
~ my-tech-blog $ git commit -m 'first commit'
~ my-tech-blog $ git branch -M main
~ my-tech-blog $ git remote add origin ${your-repository}
~ my-tech-blog $ git push -u origin main

github上でファイルのアップロードが確認できたら問題ありません。

Vercelと連携

Vercelとgithubのリポジトリを連携していきます。
下記のURLにアクセスをしましょう。
初めての場合はgithubのアカウントでログインをしましょう。

アクセスできましたら、ページ内の「Add New」ボタンをクリックし、その後「Project」をクリックします。

進んだ次のページ内にある「import Git Repository」で先ほど作成したリポジトリの「Import」ボタンをクリックします。

下記のページに進むと思います。

ATTENTION
Vercelの使用が初めての場合は、アカウントの選択、リポジトリの選択画面のようなものが順番に出てくると思いますが、先ほど作成したリポジトリのオーナーであるアカウントを選択し、デプロイしたいリポジトリを選んでいただく方向で進めていただければと思います。

プロジェクトの名前を変えたい人は自由に変更してもらって構いません。
環境変数を追加します。「Environment Variables」をクリックしてください。

.env.localに追加した内容をそのまま追加します。
keyとvalueを記入したら右の「Add」ボタンを押すと追加できます。
入力しただけではダメなので気をつけましょう。
下記のような状態になると思います。(順不同)
問題なさそうならこのまま「Deploy」のボタンを押してみましょう。

デプロイが始まったらしばらく待ちましょう。

二分ほど待つと下記の画面に進みます。

previw画面をクリックするとデプロイをしたページに飛べるので飛んでみましょう。
よく見るNext.jsのTOPページに飛べると思います。

ブラウザ上部に表示されているアドレスバー内のURL末尾に /blogsを追加してアクセスしてみましょう。

ローカルの開発環境で見ていた状態と同じものが見れていますね。
ここまできたらブログ作成のハンズオンは終了になります。

自分がデプロイしたのも貼っておきます。
my-tech-blog-hennaの-hennaの部分はVercel側が他の人のドメインと被らないように自動で割り当てしてくれてるみたいなので人によってバラバラです。

5. 参考文献

6. おわりに

今回はブログを作成していくところまでを自分の方で担当しました。

ベースはできたと思うのでここからどうアレンジしていくかは皆様にお任せいたします！

就活用の自己紹介サイトにするのもよし、ブログとして本格運営するのもよしです。

今後は、暇な時にこの記事に関連した記事を出していこうと思っています。

今日以降で出るAdventCalendarの記事で、ブログを作成をしやすくする方法、markdownのレイアウトを綺麗にする方法についても詳しく解説した記事が出る予定なので楽しみにしておいていただけますと幸いです！

最後の最後にですが、自分が作成しているブログ（開発中）も見てくださると嬉しいです。

118

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

【Next.js×microCMS×Vercel】初心者向け爆速ブログ作成ハンズオン

はじめに

目次

1. 対象者

2. 動作環境

端末

実行環境

3. 技術選定

フロントエンド

メリット

デメリット

CMS

CMSとは

microCMSとは

CSS

TailwindCSSとは

デプロイ

Vercelとは

4. 実装手順

プロジェクト作成

microCMSの設定

API_KEYの設定

microcms-js-sdkの準備

ブログ一覧を表示

ブログ詳細を表示

レイアウトを整える

CSS

一覧画面

詳細画面

確認

デプロイ

githubリポジトリを作成

Vercelと連携

5. 参考文献

6. おわりに