mirror of
https://github.com/hanzoai/next.js.git
synced 2026-09-24 17:00:51 +00:00
f54d597563
## What? Update examples `.gitignore` files for parity with [Yarn's official recommendations](https://v3.yarnpkg.com/getting-started/qa#which-files-should-be-gitignored), accounting for Yarn's modern Plug-n-Play functionality. ## Why? New projects initialized with `create-next-app` presently add various extraneous files from the Yarn cache to the initial commit. This is most notable in the case of the Next SWC binary, which may exceed 100M in some environments (empirically, 64-bit Darwin and WSL2 Ubuntu, and very probably other unix/linux environments), and prevent users from pushing their new projects to free GitHub repositories without rewriting the commit history to exclude the extraneous files, or unnecessarily setting up Git LFS to include them. ## How? I have errored on the side of exclusion to enable users to push their CNA projects to GitHub as-is and for parity with other package managers, while still providing the opportunity to opt in to additional functionality provided by modern Yarn. These changes follow the recommendations for **non**-[Zero-Install](https://yarnpkg.com/features/caching#zero-installs) configurations, as Zero-Install functionality is an extension on top of the base package manager experience, and may necessitate additional configuration and present additional complications for unsuspecting users, so I think it's best left up to the user to opt-in. On account of the majority of publicly available Next.js-based projects comprising general consumer-facing websites, it is my belief that the majority of Next projects would not benefit from Yarn's Zero-Install functionality, and that explicitly facilitating it by default would break status quo with all other non-Yarn CNA projects. Contrary to the example `.gitignore`s provided by Yarn, I've excluded the `.yarn/sdks` directory as it contains IDE-specific tooling; I feel it would be presumptuous for an environmentally-agnostic tool to target and provide package-manager-specific tooling for specific editors. This too should be left to the user to opt-in to and provide for their project if they deem necessary. I have retained the current `.gitignore`'s exclusion of the `/.pnp` directory for backwards compatibility with older versions of Yarn (the files therein have since been reallocated to the `.yarn` directory addressed by these changes, but I am not clear on when that delineation occurred or the prevalence of Yarn installations which depend on the former convention). Maintaining the exclusion here, in the worst case, implies additional downloads (on an order of magnitude merely similar to using npm from the outset) rather than failure. CC: @samcx ### Adding or Updating Examples - [x] The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - [x] Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md Co-authored-by: Sam Ko <[email protected]>
A statically generated blog example using Next.js and Sitefinity CMS
This is the existing cms-sitefinity plus TypeScript. This example showcases Next.js's Static Generation feature using Sitefinity CMS as the data source.
Demo
https://next-cms-sitefinity.vercel.app/
Deploy your own
Deploy the example using Vercel or preview live with StackBlitz
Related examples
- AgilityCMS
- Builder.io
- ButterCMS
- Contentful
- Cosmic
- DatoCMS
- DotCMS
- Drupal
- Enterspeed
- Ghost
- GraphCMS
- Kontent.ai
- MakeSwift
- Payload
- Plasmic
- Prepr
- Prismic
- Sanity
- Sitecore XM Cloud
- Sitefinity
- Storyblok
- TakeShape
- Tina
- Umbraco
- Umbraco heartcore
- Webiny
- WordPress
- Blog Starter
How to use
Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example cms-sitefinity cms-sitefinity-app
yarn create next-app --example cms-sitefinity cms-sitefinity-app
pnpm create next-app --example cms-sitefinity cms-sitefinity-app
Configuration
Step 1. Setup the CMS locally (version >=14.27922)
First, install and run the CMS Locally.
Step 2. Import the ready to use dynamic module 'Posts'
For the purpose of this demo a ready to use dynamic module was build containing two types - 'Post' and 'Author'.
In order to install it:
- Open the CMS Administration under (/Sitefinity)
- Open the Export/Import screen under (/Sitefinity/Administration/Packaging)
- Click on Import Zip file and import the file from the sitefinity folder
Step 3. Enable the web service
By default the web services are not allowed for anonymous users, so the yhave to be enabled.
Go to /sitefinity/Administration/WebServices and edit the 'Default' web service to allow it to be accessible by 'Everyone'
Step 4. Install the GraphQL package
- Add the Sitefinity CMS nugget source
- Install the Progress.Sitefinity.GraphQL package (enable prerelease filter).
Step 5. Set up environment variables
Copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):
cp .env.local.example .env.local
Then set each variable on .env.local
SF_API_URL- This is the url of the 'Default' web service that we configured earlier. E.g. http://locahost/api/default/SF_URL- This is the URL of the CMS itself. E.g. http://localhost/
Step 6. Run Next.js in development mode
npm install
npm run dev
# or
yarn
yarn dev
Your blog should be up and running on http://localhost:3000! If it doesn't work, post on GitHub discussions.