Get up and running with boilerplate for writing, testing, linting, and formatting TypeScript for a Next.js app. The generated project includes a Dockerfile for deploying the app to a server or containerized cloud environment.
npx @subfuzion/create-next-app [path]
Note
- If
path
isn't specified, it defaults to the current working directory (.
).- The directory under
path
must be empty.
Configuration boilerplate for jump starting your app development includes:
- TypeScript
- Jest
- Linting and formatting
The linting and formatting tools have been configured to work together:
.editorconfig
has format settings that feed into Prettier.eslintrc.json
uses Prettier for formatting
The generated app includes a number of package scripts for development, including:
dev
build
lint
andlint:fix
It is also configured with a pre-commit
hook using Husky and lint-staged.
To use the latest published version, enter:
npx @subfuzion/create-next-app@latest [path]
If you want to use the latest version from the GitHub repo, enter:
npx github:subfuzion/create-next-app [path]
Warning Currently under development. This implementation assumes:
- You're running the latest LTS version (or greater) of Node.js (the current implementation might work with earlier versions, but this hasn't been verified).
node
andnpm
(automatically installed with Node.js) are in the path.git
is in your path and user.name and user.email are already configured.- Your system can run a
bash
script (for now).
The source for the generated app is in the @subfuzion/next-starter-app repo.
Licensed under MIT.