next.js/examples/with-sitemap-and-robots-express-server/README.md

Example with sitemap.xml and robots.txt using Express server

How to use

Using create-next-app

Execute create-next-app with Yarn or npx to bootstrap the example:

npx create-next-app --example with-sitemap-and-robots-express-server with-sitemap-and-robots-express-server-app
# or
yarn create next-app --example with-sitemap-and-robots-express-server with-sitemap-and-robots-express-server-app

Download manually

Download the example or clone the repo:

curl https://codeload.github.com/zeit/next.js/tar.gz/canary | tar -xz --strip=2 next.js-canary/examples/with-sitemap-and-robots-expres-server
cd with-sitemap-and-robots-express-server

Install it and run:

npm install
npm run dev
# or
yarn
yarn dev

Deploy it to the cloud with now (download)

now

The idea behind the example

This example app shows you how to set up sitemap.xml and robots.txt files for proper indexing by search engine bots.

The app is deployed at: https://sitemap-robots.now.sh. Open the page and click the links to see sitemap.xml and robots.txt. Here is a snapshot of these files, with sitemap.xml on the left and robots.txt on the right:

Notes:

• routes /a and /b are added to sitemap manually
• routes that start with /posts are added automatically to sitemap; in a real application, you will get post slugs from a database

When you start this example locally:

• your app with run at https://localhost:8000
• sitemap.xml will be located at http://localhost:8000/sitemap.xml
• robots.txt will be located at http://localhost:8000/robots.txt

In case you want to deploy this example, replace the URL in the following locations with your own domain:

• hostname in server/sitemapAndRobots.js
• ROOT_URL in server/app.js
• Sitemap at the bottom of robots.txt
• alias in now.json

Deploy with now or with yarn now if you specified alias in now.json