Giter Club home page Giter Club logo

wrap-landing's Introduction

๐Ÿ”‹ ts-nextjs-tailwind-starter

Next.js + Tailwind CSS + TypeScript starter packed with useful development features.

Made by Theodorus Clarence

CodeFactor Maintainability Rating Bugs GitHub Repo stars

Depfu Last Update

Features

This repository is ๐Ÿ”‹ battery packed with:

  • โšก๏ธ Next.js 13
  • โš›๏ธ React 18
  • โœจ TypeScript
  • ๐Ÿ’จ Tailwind CSS 3 โ€” Configured with CSS Variables to extend the primary color
  • ๐Ÿ’Ž Pre-built Components โ€” Components that will automatically adapt with your brand color, check here for the demo
  • ๐Ÿƒ Jest โ€” Configured for unit testing
  • ๐Ÿ“ˆ Absolute Import and Path Alias โ€” Import components using @/ prefix
  • ๐Ÿ“ ESLint โ€” Find and fix problems in your code, also will auto sort your imports
  • ๐Ÿ’– Prettier โ€” Format your code consistently
  • ๐Ÿถ Husky & Lint Staged โ€” Run scripts on your staged files before they are committed
  • ๐Ÿค– Conventional Commit Lint โ€” Make sure you & your teammates follow conventional commit
  • โฐ Release Please โ€” Generate your changelog by activating the release-please workflow
  • ๐Ÿ‘ท Github Actions โ€” Lint your code on PR
  • ๐Ÿš˜ Automatic Branch and Issue Autolink โ€” Branch will be automatically created on issue assign, and auto linked on PR
  • ๐Ÿ”ฅ Snippets โ€” A collection of useful snippets
  • ๐Ÿ‘€ Default Open Graph โ€” Awesome open graph generated using og, fork it and deploy!
  • ๐Ÿ—บ Site Map โ€” Automatically generate sitemap.xml
  • ๐Ÿ“ฆ Expansion Pack โ€” Easily install common libraries, additional components, and configs

See the ๐Ÿ‘‰ feature details and changelog ๐Ÿ‘ˆ for more.

You can also check all of the details and demos on my blog post:

Getting Started

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

  1. Use this repository as template

    Disclosure: by using this repository as a template, there will be an attribution on your repository.

    I'll appreciate if you do, so this template can be known by others too ๐Ÿ˜„

    Use as template

  2. Using create-next-app

    npx create-next-app -e https://github.com/theodorusclarence/ts-nextjs-tailwind-starter project-name
  3. Using degit

    npx degit theodorusclarence/ts-nextjs-tailwind-starter YOUR_APP_NAME
  4. Deploy to Vercel

    Deploy with Vercel

2. Install dependencies

It is encouraged to use yarn so the husky hooks can work properly.

yarn install

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 src/pages/index.tsx.

4. Change defaults

There are some things you need to change including title, urls, favicons, etc.

Find all comments with !STARTERCONF, then follow the guide.

Don't forget to change the package name in package.json

5. Commit Message Convention

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

Projects using ts-nextjs-tailwind-starter

Are you using this starter? Please add your page (and repo) to the end of the list via a Pull Request. ๐Ÿ˜ƒ

Expansion Pack ๐Ÿ“ฆ

This starter is now equipped with an expansion pack.

You can easily add expansion such as React Hook Form + Components, Storybook, and more just using a single command line.

CleanShot.2021-12-04.at.18.54.07-trimmed.mp4

Check out the expansion pack repository for the commands

wrap-landing's People

Contributors

agamm avatar ahmedkhitaby avatar beshoi avatar depfu[bot] avatar raaynaldo avatar theodorusclarence avatar

Watchers

 avatar  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.