template-next-ts-pwa

A project template for Next.js PWA, with TypeScript.

Requirements

Getting Started

Clone this template:

git clone https://github.com/saltchang/template-next-ts-pwa.git

Rename to your app's name:

cp -r template-next-ts-pwa <your-app>
cd <your-app>

Set up the project:

# replace the project name to yours
sed -i 's/template-next-ts-pwa/<your-app>/g' package.json README.md yarn.lock

# run this if you are on a BSD systems like macOS
sed -i '.bak' 's/template-next-ts-pwa/<your-app>/g' package.json README.md yarn.lock

You can also choose to reset the git repository (optional):

rm -rf .git
git init

Usage

Install the dependencies:

yarn

Start the development server:

yarn dev

Run test:

yarn test

Build the Production package:

yarn build

Run the Production package:

yarn start

Run linting:

yarn lint

# with fix
yarn lint-fix

Format documents:

yarn format