Code Monkey home page Code Monkey logo

next-starter's Introduction

Next.js Starter

Next starter for standard marketing sites that have SEO considerations. Does not include set up for CMS.

Setup

  • run pnpm install
  • update /src/data/general.json
  • update urls in /robots.txt

Features

CSS & Tailwind

https://github.com/vercel/next.js/tree/canary/examples/with-tailwindcss

  • added styles folder with a global.css that includes tailwind imports
  • includes aspect ratio plugin

SRC Folder

  • src folder has been added to keep everything tidy.

Absolute Imports

ESLint

Layout

SEO

  • uses https://github.com/garmeeh/next-seo for SEO
  • next-seo.config contains defaults for OpenGraph but hasn't been configured fully.
  • _app.jsx contains a <DefaultSeo {...SEO} /> that contains the defaults
  • src/components/Layout.jsx contains <NextSEO> main component which contains the title, description and canonical props.
  • each page is wrapped in <Layout> and passes back the title and description via a variable at the top of the file.

Environment Variables

Sitemap

  • sitemap is generated for static pages via next-sitemap.
  • package.json contains a postbuild step that builds the sitemap into the public folder.
  • also generates a robots.txt into the public folder

Custom Document

Custom App

To Do

  • add add explaination for tailwind plugins
  • add api pages to read me
  • add consistent styling
  • add in commonly used CMS settings? as branches?
  • add next image example
  • add basic typograpical defaults
  • be better at commit messages

next-starter's People

Contributors

adamjbragg avatar

Stargazers

Lucas Ciapparelli avatar Jacob Dubail 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.