28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
# NextJS Typescript Boilerplate
|
|
|
|
Bootstrap a developer-friendly NextJS app configured with:
|
|
|
|
- [Typescript](https://www.typescriptlang.org/)
|
|
- Linting with [ESLint](https://eslint.org/)
|
|
- Formatting with [Prettier](https://prettier.io/)
|
|
- Linting, typechecking and formatting on by default using [`husky`](https://github.com/typicode/husky) for commit hooks
|
|
- Testing with [Jest](https://jestjs.io/) and [`react-testing-library`](https://testing-library.com/docs/react-testing-library/intro)
|
|
|
|
## Deploy your own
|
|
|
|
Deploy the example using [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example):
|
|
|
|
[](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/with-typescript-eslint-jest&project-name=with-typescript-eslint-jest&repository-name=with-typescript-eslint-jest)
|
|
|
|
## How to use
|
|
|
|
Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init) or [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/) to bootstrap the example:
|
|
|
|
```bash
|
|
npx create-next-app --example with-typescript-eslint-jest with-typescript-eslint-jest-app
|
|
# or
|
|
yarn create next-app --example with-typescript-eslint-jest with-typescript-eslint-jest-app
|
|
```
|
|
|
|
Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).
|