Git Product home page Git Product logo

builderio-nextjs-isr-seo-starter's Introduction

Builder.IO & NextJs starter with ISR & SEO optimization

This project aims to be a starting project for every initiative around Builder.io and Next.js that requires ISR capabilities and SEO optimizations like having a dynamic sitemap.xml and a few other tricks.

If you want to see a live site using this starter go to Kenzilab.com.

Features

  • Typescript support ❤️
  • ISR for every Page generated.
  • Sitemap.xml generated in SSR connected with Builder.io
  • NextSeo package added.
  • Robots.txt
  • Perfect Lighthouse Score 100 / 100 / 100 / 100 by default.

Initial setup

  • Clone this repo.
  • Run npm i command.
  • Create your environment variables file. Create a .env file in the root with the following values.
    • NEXT_PUBLIC_BUILDER_PUBLIC_KEY - This is obtained through the Builder.io admin panel. For detailed instructions on getting your API Key, check out Finding your Public API Key in the Using Builder API Keys documentation.
    • REVALIDATE_SECRET - This is a custom-generated key for granting access to the revalidate endpoint. Use your favorite password generator or use your own one.
  • Go to Builder.io and create the first page (https://www.builder.io/c/docs/create-page).
  • Enable Builder.io Webhook for pages (https://www.builder.io/c/docs/webhooks) make sure you point it to /api/revalidate?secret={REVALIDATE_SECRET}.
  • Adjust the values you want to use for SEO. You can edit them in /src/config/seo.

Starting the server (locally)

It is as easy as running npm run dev and open a web browser in http://localhost:3000.

Deploy on Vercel

I recommend using Vercel. This repo also has Vercel Analytics npm dependency so it is included out of the box.

Deploy with Vercel

You will have to configure the environment variables in the admin panel. Name them as they are in the .env file.

Deploy elsewhere

I refer you to the official Next.js documentation.

Although there are many choices out there I recommend exploring Cloudflare Pages. It is easy, powerful, costless and very straightforward.

Websites using this project

If you want to list here your project you can open a PR with your url.

builderio-nextjs-isr-seo-starter's People

Contributors

kapunahelewong avatar kenzitron avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.