Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(examples): Deprecate
cms-strapi
(#43325)
Co-authored-by: Balázs Orbán <info@balazsorban.com>
- Loading branch information
1 parent
29a9134
commit a746597
Showing
46 changed files
with
2 additions
and
1,058 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,153 +1,3 @@ | ||
# A statically generated blog example using Next.js and Strapi | ||
## Deprecated | ||
|
||
This example showcases Next.js's [Static Generation](https://nextjs.org/docs/basic-features/pages) feature using [Strapi](https://strapi.io/) as the data source. | ||
|
||
## Demo | ||
|
||
[https://next-blog-strapi.vercel.app/](https://next-blog-strapi.vercel.app/) | ||
|
||
## Deploy your own | ||
|
||
Once you have access to [the environment variables you'll need](#step-7-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/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/cms-strapi&project-name=cms-strapi&repository-name=cms-strapi&env=STRAPI_PREVIEW_SECRET,NEXT_PUBLIC_STRAPI_API_URL&envDescription=Required%20to%20connect%20the%20app%20with%20Strapi&envLink=https://vercel.link/cms-strapi-env) | ||
|
||
### Related examples | ||
|
||
- [WordPress](/examples/cms-wordpress) | ||
- [DatoCMS](/examples/cms-datocms) | ||
- [Sanity](/examples/cms-sanity) | ||
- [TakeShape](/examples/cms-takeshape) | ||
- [Prismic](/examples/cms-prismic) | ||
- [Contentful](/examples/cms-contentful) | ||
- [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) | ||
- [Ghost](/examples/cms-ghost) | ||
- [Umbraco Heartcore](/examples/cms-umbraco-heartcore) | ||
- [Blog Starter](/examples/blog-starter) | ||
- [Builder.io](/examples/cms-builder-io) | ||
- [DotCMS](/examples/cms-dotcms) | ||
- [Enterspeed](/examples/cms-enterspeed) | ||
|
||
## 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), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example: | ||
|
||
```bash | ||
npx create-next-app --example cms-strapi cms-strapi-app | ||
``` | ||
|
||
```bash | ||
yarn create next-app --example cms-strapi cms-strapi-app | ||
``` | ||
|
||
```bash | ||
pnpm create next-app --example cms-strapi cms-strapi-app | ||
``` | ||
|
||
## Configuration | ||
|
||
### Step 1. Set up Strapi locally | ||
|
||
Use the provided [Strapi template Next example](https://github.com/strapi/strapi-template-next-example) to run a pre-configured Strapi project locally. See the [Strapi template docs](https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/installation/templates.html#templates) for more information | ||
|
||
```bash | ||
npx create-strapi-app@3 my-project --template next-example --quickstart | ||
# or: yarn create strapi-app@3 my-project --template next-example --quickstart | ||
npm run develop # or: yarn develop | ||
``` | ||
|
||
This will open http://localhost:1337/ and prompt you to create an admin user. | ||
|
||
After you sign in there should already be data for **Authors** and **Posts**. If you want to add more entries, just do the following: | ||
|
||
Select **Author** and click **Add New Author**. | ||
|
||
- Use dummy data for the name. | ||
- For the image, you can download one from [Unsplash](https://unsplash.com/). | ||
|
||
Next, select **Posts** and click **Add New Post**. | ||
|
||
- 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. | ||
- Set the **status** field to be **published**. | ||
|
||
### Step 2. Set up environment variables | ||
|
||
While the Strapi server is running, open a new terminal and `cd` into the Next.js app directory you created earlier. | ||
|
||
``` | ||
cd cms-strapi-app | ||
``` | ||
|
||
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`: | ||
|
||
- `STRAPI_PREVIEW_SECRET` can be any random string (but avoid spaces), like `MY_SECRET` - this is used for [Preview Mode](https://nextjs.org/docs/advanced-features/preview-mode). | ||
- `NEXT_PUBLIC_STRAPI_API_URL` should be set as `http://localhost:1337` (no trailing slash). | ||
|
||
### Step 3. Run Next.js in development mode | ||
|
||
Make sure that the local Strapi server is still running at http://localhost:1337. Inside the Next.js app directory, run: | ||
|
||
```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)! | ||
|
||
The best place to debug is inside the `fetchAPI` function in `lib/api.js`. If you need help, you can post on [GitHub discussions](https://github.com/vercel/next.js/discussions). | ||
|
||
### Step 4. Try preview mode | ||
|
||
If you go to the `/posts/draft` page on localhost, you won't see this post because it’s not published. 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=<secret>&slug=draft | ||
``` | ||
|
||
- `<secret>` should be the string you entered for `STRAPI_PREVIEW_SECRET`. | ||
- `<slug>` should be the post's `slug` attribute. | ||
|
||
You should now be able to see the draft post. To exit the preview mode, you can click **Click here to exit preview mode** at the top. | ||
|
||
To add more preview pages, create a post and set the **status** as `draft`. | ||
|
||
### Step 5. Deploy Strapi | ||
|
||
To deploy to production, you must first deploy your Strapi app. The Strapi app for our demo at https://next-blog-strapi.vercel.app/ is deployed to Heroku ([here’s the documentation](https://strapi.io/documentation/developer-docs/latest/setup-deployment-guides/deployment/hosting-guides/heroku.html)) and uses Cloudinary for image hosting ([see this file](https://github.com/strapi/strapi-starter-next-blog/blob/23b184781a3f219ad472f6a2c3a3d239a3d16513/backend/extensions/upload/config/settings.js)). | ||
|
||
### Step 6. 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/new?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/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/cms-strapi&project-name=cms-strapi&repository-name=cms-strapi&env=STRAPI_PREVIEW_SECRET,NEXT_PUBLIC_STRAPI_API_URL&envDescription=Required%20to%20connect%20the%20app%20with%20Strapi&envLink=https://vercel.link/cms-strapi-env) | ||
The Strapi CMS example is deprecated. Please check out [Strapi’s official demo application](https://github.com/strapi/foodadvisor/). |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.