Skip to content

PlitzCorporation/plitz-one

Repository files navigation

Next, TypeScript, Material UI and CSS Boilerplate

Plitz One - The beginning of every project

Next, TypeScript, Material UI and CSS Boilerplate packed with useful development features.

Created by Norman Plietez @ Plitz7

Features

Repository Main Features:

  • Built with Next.JS 13
  • React 18
  • TypeScript
  • We are using CSS Modules and Material UI for styling. If you master CSS then you can switch to Tailwind.
  • Import using @componen, @pages, @lib and @styles prefix
  • ESLint
  • Husky & Lint Staged
  • Github Actions
  • Default Open Graph
  • Site Map — Automatically generate sitemap.xml

Getting Started

1. Clone this template using one of the three ways:

  1. Using create-next-app

    npx create-next-app -e https://github.com/PlitzCorporation/plitz-one project-name
    
  2. Regular Clonning git clone

    git clone https://github.com/PlitzCorporation/plitz-one
    

2. Install dependencies

Works better with yarn.

yarn install

If you preffer npm make sure you know what you are doing before preceeding.

3. Run the development server

You can start the server using this command:

yarn dev

Open http://localhost:3000 with your browser to see the result. You can start editing the page by modifying pages/index.tsx.

4. Commit Message Convention

This starter is using conventional commits, it is mandatory to use it to commit changes.

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Check file commitlint.config.js and make sure you understand it to use this CMC rules properly.

Credits that we feature and we recommend your support

Theodorus Clarence | TS + Next.js + Tailwind: GitHub Repo stars