https://github.com/ederssouza/nextjs-boilerplate

Next.js boilerplate
https://github.com/ederssouza/nextjs-boilerplate

eslint jest nextjs plop prettier react react-testing-library styled-components typescript

Last synced: about 18 hours ago
JSON representation

Next.js boilerplate

• Host: GitHub
• URL: https://github.com/ederssouza/nextjs-boilerplate
• Owner: ederssouza
• Created: 2022-02-05T22:19:04.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-11-02T12:29:36.000Z (6 days ago)
• Last Synced: 2024-11-02T13:19:31.230Z (5 days ago)
• Topics: eslint, jest, nextjs, plop, prettier, react, react-testing-library, styled-components, typescript
• Language: TypeScript
• Homepage:
• Size: 4.75 MB
• Stars: 7
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

## Next.js Boilerplate

This is a [Next.js](https://nextjs.org/) boilerplate.

## What is inside?

This project uses lot of stuff as:

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

- [NextJS](https://nextjs.org/)

- [Styled Components](https://styled-components.com/)

- [Jest](https://jestjs.io/)

- [React Testing Library](https://testing-library.com/docs/react-testing-library/intro)

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

- [Eslint](https://eslint.org/)

- [Prettier](https://prettier.io/)

- [Husky](https://github.com/typicode/husky)

## Starting NextJS project from boilerplate repository

```bash

npx create-next-app -e https://github.com/ederssouza/nextjs-boilerplate

# or

yarn create next-app -e https://github.com/ederssouza/nextjs-boilerplate

```

## Getting Started

First, run the development server:

```bash

npm run dev

# or

yarn dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `pages/index.js`. The page auto-updates as you edit the file.

## Commands

- `dev`: runs your application on `localhost:3000`

- `build`: creates the production build version

- `start`: starts a simple server with the build production code

- `lint`: runs the linter in all components and pages

- `test`: runs jest to test all components and pages

- `test:watch`: runs jest in watch mode

- `coverage-test`: runs jest to make coverage test of all components and pages

- `coverage-test:watch`: runs jest to make coverage test of all components and pages in watch mode

- `test:ci`: run all tests serially in the current process, rather than creating a worker pool of child processes that run tests. This can be useful for debugging.

- `generate`: generates a basic component structure

- `storybook`: runs storybook on `localhost:6006`

- `build-storybook`: create the build version of storybook

## Learn More

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.

- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!

## Deploy on Vercel

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/import?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.