Giter VIP home page Giter VIP logo

timonwa / nextjs-typescript-boilerplate Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 136 KB

A starter template for Next.js with TypeScript. Kickstart your Next.js projects with built-in linting, formatting, and commit message checks.

License: MIT License

Shell 2.04% CSS 63.07% TypeScript 33.20% JavaScript 1.69%
commitlint commitlint-config husky husky-hooks lint-staged lint-staged-config nextjs nextjs-boilerplate nextjs-template nextjs-typescript

nextjs-typescript-boilerplate's Introduction

Next.js TypeScript Boilerplate

A starter template for Next.js with TypeScript. Kickstart your Next.js projects with built-in linting, formatting, and commit message checks.

๐Ÿ“ Architecture

This project is designed to help you get started quickly with Next.js and TypeScript. It includes the following key technologies:

Upon each commit, the following checks are automatically performed:

  • Linting: Ensure your code follows consistent coding standards.
  • Prettier: Automatically format your code for consistent style.
  • Commit Message Format: Enforce clear and standardized commit messages.

๐Ÿš€ Getting Started

Installation

  1. Fork this repository to your own GitHub account.

  2. Clone the repository to your local machine:

    git clone https://github.com/yourusername/nextjs-typescript-boilerplate.git
  3. Install project dependencies:

    npm install
  4. Start the development server:

    npm run dev
  5. Open your web browser and navigate to http://localhost:3000 to see your Next.js application in action.

๐Ÿงฐ Features

  • TypeScript: Write your code with the benefits of static typing.
  • Next.js: Enjoy server-side rendering, routing, and more.
  • Prettier: Keep your codebase consistently formatted.
  • Commitlint: Enforce commit message conventions for better collaboration.
  • Husky: Easily manage Git hooks.
  • Lint-staged: Run linters on pre-committed files only.

๐Ÿ“„ License

This project is open-source and available under the MIT License. Feel free to use, modify, and distribute it according to your needs.

๐Ÿ™ Acknowledgments

Special thanks to the creators of the technologies that make this starter template possible:

nextjs-typescript-boilerplate's People

Contributors

timonwa avatar

Stargazers

 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.