https://github.com/jorge79/boilerplate

A template used at the React Avançado course, and personal projects
https://github.com/jorge79/boilerplate

nextjs prettier-eslint storybook styled-components testing-library typescript

Last synced: 13 days ago
JSON representation

A template used at the React Avançado course, and personal projects

• Host: GitHub
• URL: https://github.com/jorge79/boilerplate
• Owner: Jorge79
• Created: 2022-01-30T06:02:54.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-02-28T00:19:04.000Z (over 1 year ago)
• Last Synced: 2023-03-04T05:27:17.644Z (over 1 year ago)
• Topics: nextjs, prettier-eslint, storybook, styled-components, testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 1.33 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        

This is a [Next.js](https://nextjs.org/) boilerplate to be used in a course called [React Avançado](https://reactavancado.com.br/).

![ci](https://github.com/React-Avancado/boilerplate/workflows/ci/badge.svg)

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

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

- `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.