https://github.com/santosl2/project-next-base

Boilerplate Next.js já com eslint, prettier, testing-library, storybook, tailwind e styled-components configurados.
https://github.com/santosl2/project-next-base

boilerplate cssinjs eslint nextjs prettier react reactjs storybook styled-components testing-library typescript

Last synced: 16 days ago
JSON representation

Boilerplate Next.js já com eslint, prettier, testing-library, storybook, tailwind e styled-components configurados.

• Host: GitHub
• URL: https://github.com/santosl2/project-next-base
• Owner: Santosl2
• License: mit
• Created: 2022-01-12T18:59:51.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-02-20T13:43:49.000Z (9 months ago)
• Last Synced: 2024-02-20T23:41:38.058Z (9 months ago)
• Topics: boilerplate, cssinjs, eslint, nextjs, prettier, react, reactjs, storybook, styled-components, testing-library, typescript
• Language: TypeScript
• Homepage:
• Size: 1.62 MB
• Stars: 10
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![License: MIT](https://img.shields.io/badge/License-MIT-red.svg)](https://opensource.org/licenses/MIT)

[![Next.JS](https://img.shields.io/badge/NextJS-blue)](https://nextjs.org/)

[![React.js](https://img.shields.io/badge/-ReactJS-blue)](https://pt-br.reactjs.org/)

[![Typescript](https://img.shields.io/badge/-Typescript-blue)](https://www.typescriptlang.org/)



    
Boilerplate with Next JS, Typescript, ESlint, Prettier, Storybook, Testing Library, Styled Components and Husky

    



- [Instalation](#instalation)

- [Project Structure Recomendation](#project-structure-recomendation)

# Instalation

Just clone this repo or use as a template and enjoy!

## Project Structure Recomendation

- src

  - components

    - Button/

      - Button.stories.tsx (Docs)

      - Button.styles.(ts) (Styles)

      - Button.tsx (Component)

      - Button.spec.tsx (Test)

      - Button.types.tsx (Interface/Types)

      - index.ts (Export Button.tsx)

  - pages (all Pages)

  - shared

    - hooks

      - use[Hook Name].ts (Ex.: useAuth.ts)

      - index.ts (export all hooks)

    - contexts

      - [ContextName]Context.tsx (Ex.: AuthContext.tsx)

    - services (API Call config)

    - utils (project utils)

      - tests (utils for tests)

      - index.ts (export all utils)

Thanks!