# A statically generated blog example using Next.js and TakeShape This example showcases Next.js's [Static Generation](https://nextjs.org/docs/basic-features/pages) feature using [TakeShape](https://www.takeshape.io/) as the data source. ## Demo ### [https://next-blog-takeshape.now.sh/](https://next-blog-takeshape.now.sh/) ## Deploy your own Once you have access to [the environment variables you'll need](#step-5-set-up-environment-variables), deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example): [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/cms-takeshape&env=TAKESHAPE_PROJECT_ID,TAKESHAPE_API_KEY,TAKESHAPE_PREVIEW_SECRET&envDescription=Required%20to%20connect%20the%20app%20with%20TakeShape&envLink=https://vercel.link/cms-takeshape-env) ### Related examples - [WordPress](/examples/cms-wordpress) - [DatoCMS](/examples/cms-datocms) - [Sanity](/examples/cms-sanity) - [Prismic](/examples/cms-prismic) - [Contentful](/examples/cms-contentful) - [Strapi](/examples/cms-strapi) - [Agility CMS](/examples/cms-agilitycms) - [Cosmic](/examples/cms-cosmic) - [ButterCMS](/examples/cms-buttercms) - [Storyblok](/examples/cms-storyblok) - [GraphCMS](/examples/cms-graphcms) - [Kontent](/examples/cms-kontent) - [Blog Starter](/examples/blog-starter) ## How to use Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example: ```bash npx create-next-app --example cms-takeshape cms-takeshape-app # or yarn create next-app --example cms-takeshape cms-takeshape-app ``` ## Configuration ### Step 1. Create an account and a project on TakeShape First, [create an account on TakeShape](https://www.takeshape.io/). After creating an account, create a **new project** from the dashboard. You can select a **Blank Project**. ### Step 2. Create an `Author` model From the project settings page, create a new **content type**. - The title should be `Author`. Next, drag these widgets: - **Single Line** widget: Set the title as **Name**. - **Asset** widget: Set the title as **Picture**. When you’re done, click "Create Content Type". ### Step 3. Create a `Post` model Click **Add Content Type** again. - The title should be `Post`. Next, add these fields (you don't have to modify the settings unless specified): - **Single Line** widget: Set the title as **Title**. - **Markdown** widget: Set the title as **Content**. - **Single Line** widget: Set the title as **Excerpt**. - **Asset** widget: Set the title as **Cover Image**. - **Date** widget: Set the title as **Date**. - **Single Line** widget: Set the title as **Slug**. - **Relationship** widget: Set the title as **Author**, then set **Relationship Type** to `Single` and check the `Author` checkbox under **Allowed Content Types**. When you’re done, click "Create Content Type". ### Step 4. Populate Content Select **Author** and create a new record. - You just need **1 Author record**. - Use dummy data for the text. - For the image, you can download one from [Unsplash](https://unsplash.com/). When you’re done, make sure to click **Enabled** under **Workflow Status**. Next, select **Post** and create a new record. - We recommend creating at least **2 Post records**. - Use dummy data for the text. - You can write markdown for the **Content** field. - For the images, you can download ones from [Unsplash](https://unsplash.com/). - Pick the **Author** you created earlier. When you’re done, make sure to click **Enabled** under **Workflow Status**. ### Step 5. Set up environment variables From the dropdown next to the project name, click **API Keys**. Create a new API Key with the **Read** permission. Next, copy the `.env.local.example` file in this directory to `.env.local` (which will be ignored by Git): ```bash cp .env.local.example .env.local ``` Then set each variable on `.env.local`: - `TAKESHAPE_API_KEY` should be the API token you just copied. - `TAKESHAPE_PROJECT_ID` should be the project ID, which is a substring in the project page URL: `https://app.takeshape.io/projects//...` - `TAKESHAPE_PREVIEW_SECRET` can be any random string (but avoid spaces), like `MY_SECRET` - this is used for [the Preview Mode](https://nextjs.org/docs/advanced-features/preview-mode). Your `.env.local` file should look like this: ```bash TAKESHAPE_PROJECT_ID=... TAKESHAPE_API_KEY=... TAKESHAPE_PREVIEW_SECRET=... ``` ### Step 6. Run Next.js in development mode ```bash npm install npm run dev # or yarn install yarn dev ``` Your blog should be up and running on [http://localhost:3000](http://localhost:3000)! If it doesn't work, post on [GitHub discussions](https://github.com/vercel/next.js/discussions). ### Step 7. Try preview mode On TakeShape, create a new post like before. But **DO NOT** click **Enabled** under **Workflow Status**. Now, if you go to `http://localhost:3000/posts/` (replace ``), you won’t see the post. However, if you use the **Preview Mode**, you'll be able to see the change ([Documentation](https://nextjs.org/docs/advanced-features/preview-mode)). To enable the Preview Mode, go to this URL: ``` http://localhost:3000/api/preview?secret=&slug= ``` - `` should be the string you entered for `TAKESHAPE_PREVIEW_SECRET`. - `` should be the post's `slug` attribute (you can check on TakeShape). You should now be able to see this post. To exit the preview mode, you can click **Click here to exit preview mode** at the top. ### Step 8. Deploy on Vercel You can deploy this app to the cloud with [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). #### Deploy Your Local Project To deploy your local project to Vercel, push it to GitHub/GitLab/Bitbucket and [import to Vercel](https://vercel.com/import/git?utm_source=github&utm_medium=readme&utm_campaign=next-example). **Important**: When you import your project on Vercel, make sure to click on **Environment Variables** and set them to match your `.env.local` file. #### Deploy from Our Template Alternatively, you can deploy using our template by clicking on the Deploy button below. [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/git?c=1&s=https://github.com/vercel/next.js/tree/canary/examples/cms-takeshape&env=TAKESHAPE_PROJECT_ID,TAKESHAPE_API_KEY,TAKESHAPE_PREVIEW_SECRET&envDescription=Required%20to%20connect%20the%20app%20with%20TakeShape&envLink=https://vercel.link/cms-takeshape-env)