https://github.com/croutonn/next-template

next.js template
https://github.com/croutonn/next-template

nextjs-boilerplate nextjs-example nextjs-starter nextjs-template nextjs-typescript

Last synced: 6 days ago
JSON representation

next.js template

• Host: GitHub
• URL: https://github.com/croutonn/next-template
• Owner: croutonn
• Created: 2020-09-26T08:21:11.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2021-05-28T18:54:42.000Z (over 3 years ago)
• Last Synced: 2023-03-05T22:12:53.919Z (over 1 year ago)
• Topics: nextjs-boilerplate, nextjs-example, nextjs-starter, nextjs-template, nextjs-typescript
• Language: TypeScript
• Homepage:
• Size: 4.57 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# NextJS Typescript Boilerplate

Bootstrap a developer-friendly NextJS app configured with:

- [Typescript](https://www.typescriptlang.org/)

- Linting with [ESLint](https://eslint.org/) and [stylelint](https://stylelint.io/)

- 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)

- [Storybook](https://storybook.js.org/)

## Deploy your own

Deploy the example using [Vercel](https://vercel.com):

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/import/project?template=https://github.com/croutonn/next-template/tree/main)

## 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 https://github.com/croutonn/next-template with-typescript-eslint-jest-app

# or

yarn create next-app --example https://github.com/croutonn/next-template with-typescript-eslint-jest-app

```

Deploy it to the cloud with [Vercel](https://vercel.com/import) ([Documentation](https://nextjs.org/docs/deployment)).