https://github.com/mmatongo/next-tailwind-typescript-boilerplate

Boilerplate for Tailwind CSS, TypeScript, and Next.js
https://github.com/mmatongo/next-tailwind-typescript-boilerplate

Last synced: about 2 months ago
JSON representation

Boilerplate for Tailwind CSS, TypeScript, and Next.js

• Host: GitHub
• URL: https://github.com/mmatongo/next-tailwind-typescript-boilerplate
• Owner: mmatongo
• Created: 2022-03-09T10:08:42.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-10-27T10:24:00.000Z (about 2 years ago)
• Last Synced: 2023-04-28T09:52:54.672Z (over 1 year ago)
• Language: TypeScript
• Size: 120 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Tailwind CSS + TypeScript + Next.js Starter

This is a lightweight starterkit / boilerplate to get up and running with Tailwind CSS, TypeScript and Next.js. It is also production-ready with a Purge CSS setup.

## Why make this boilerplate?

Tailwind, Next.js, and TypeScript is an excellent stack for building web apps. The most annoying part of using the stack

is setting it up every time, so I made an easy to use template that I and many others can use.

## Usage

### 1. Clone Repo

Github released [Github Templates](https://github.blog/2019-06-06-generate-new-repositories-with-repository-templates/) which allows users to generate a new repo from a template repo that will have the exact same files and structure. You can generate your own repo from this template by using [this link](https://github.com/mmatongo/next-tailwind-typescript-boilerplate/generate).

From there, you can clone your own repo and modify it however you like.

If you would rather clone this repo, go to the command line and run:

```bash

git clone https://github.com/mmatongo/next-tailwind-typescript-boilerplate 

cd 

```

### 2. Install Dependencies

```bash

yarn # npm i

```

### 3. Run Development Environment

```bash

yarn dev # npm run dev

```

### Test Production Environment

I also included a `stage` script that will build and start a production server. You can run it with:

```bash

yarn stage # npm run stage

```

Alternatively you can run:

```bash

yarn build # npm run build

yarn start # npm start

```

## Important Notes

* Be sure to update the `package.json` to include your own information for the project you're working on.

* Purge CSS will only run in production, so use either `build` or `stage` to run it and minimize your CSS file size. You can also modify the `postcss.config.js` file to enable Purge CSS in development.