NextStarter
Menu

About NextStarter

This is a boilerplate I put together for creating my front-end projects with NextJS, TypeScript, and Tailwind. It includes all of the linting and formatting rules that I like to use with ESLint and Prettier as well as a theme switcher for dark and light modes. It also includes a few other niceties like a custom 404 page, robots.txt and sitemap.xml files, and VS Code settings.

To begin your project, please see the Getting Started section below.

Tech Stack

NextJS
TypeScript
Tailwind
Prettier
ESLint
VS Code

Features

  • ESLint config and rules
  • Prettier configuration setup for Tailwind
  • Icons from React Icons
  • ShadCN/UI for theming and component library
  • Built-in light and dark themes
  • Node version file
  • Custom 404 page
  • Robots and Sitemap files
  • VS Code settings and recommended extensions
  • GitHub Actions workflow

Getting Started

  1. 1

    Clone the repository

    View on GitHub
  2. 2

    Create environment file

    Create an .env file by making a copy of the .env.example file.

  3. 3

    Install dependencies

    npm install
  4. 4

    Start development server

    npm run dev
  5. 5

    View in browser

    Open http://localhost:3000 in your browser