marcogomesr / template-next-typescript-twin-styled-eslint-starter

A TypeScript, Twin.macro, Styled Components, and ESLint Next.js starter template

✨ TypeScript + Twin + Styled + Eslint + Airbnb + Prettier + Next.js Starter ✨

A lightweight boilerplate to get up and running with TypeScript, Tailwind CSS, Twin, Styled Components, ESLint with Airbnb/Prettier set up with Next.js.

🔍 Preview

🔧 Getting Started

You can generate your own repo from this template by using this link.

You can also clone this repository by using the command line:

git clone https://github.com/vinhvn/next-typescript-twin-styled-eslint-starter app
cd app
yarn # npm i

Remember to install dependencies after cloning it locally.

Run Development Environment

yarn dev # npm run dev

Test Production Environment

The stage script will build and start a production server.

yarn stage # npm run stage

Alternatively you can run:

yarn build # npm run build
yarn start # npm start

Static HTML

The export script will build the files to be served statically. Note that this comes with some caveats.

yarn export # npm run export

📝 Important Notes

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