iClouds - Boilerplate em NextJS

Tecnologias • Arquitetura • Como usar

Status: Em andamento!

---

Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

• Next.js
• TypeScript

Auxiliares

• Jest
• Plop
• Styled Components

Padronização de código/commits:

• Husky
• ESLint
• Prettier

---

Arquitetura

src/
|-- components/   # Contém os components reutilizáveis do projeto.
|--- buttons/     # Contém os botões do projeto.
|--- cards/       # Contém os cards do projeto.
|--- inputs/      # Contém os inputs do projeto.
|--- sections/    # Contém todas as sections do projeto.
|---- home/       # Contém as seções da home.
|--- SEO/         # Contém o SEO do projeto.
|-- functions/    # Funções globais, que podem ser reutilizadas.
|-- hooks/        # Contém todos os hooks do projeto.
|-- interfaces/   # Contém a tipagem dos components do projeto.
|-- pages/        # Todas as páginas do projeto estão dentro dessa pasta.
|-- services/     # Contém as configurações das APIs.
|-- styles/       # Contém todos os arquivos relacionados a padronização de estilos do projeto.

---

Como usar

Pré-requisitos

Antes de começar, precisa-se ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, yarn ou npm.

Usando o template:

Siga os passos a seguir para iniciar o projeto utilizando o boilerplate.

Criar projeto:

  yarn create next-app -e https://github.com/iClouds-Sistemas-Web/nextjs-typescript-boilerplate-iclouds

Acesse a pasta do projeto no terminal/cmd:

cd repository-name

Instale as dependências com yarn ou npm:

yarn
# ou npm install

Execute a aplicação em modo de desenvolvimento:

yarn dev

O servidor inciará na porta :3000 - acesse http://localhost:3000

---