neki-react-components v0.0.15

Next.js Template

Descrição

-- Este template deverá ser utilizado como base para a criação de futuros projetos.

Como Utilizar o Template

Se você deseja iniciar um novo projeto com base neste template, siga as seguintes etapas:

Passo 1: Acesse o Repositório do Template

1. Na parte superior direita da página do repositório, clique no botão "Use this template" e, em seguida, na opção "Create a new repository".

2. Você será redirecionado para uma nova página onde poderá configurar o novo repositório.

Passo 2: Configure o Novo Repositório

1. Escolha um nome para o novo repositório.

2. Se desejar, adicione uma descrição.

3. Escolha a visibilidade 'privado'.

4. Clique no botão "Create repository".

Passo 3: Clone o Novo Repositório

1. Após criar o novo repositório, você será redirecionado para a página do novo repositório.

2. Clique no botão "Code" e copie a URL do repositório.

3. Abra o terminal (linha de comando) no seu computador e navegue até o diretório onde deseja clonar o novo repositório.

4. Use o comando git clone seguido da URL do repositório para clonar o novo projeto para o seu computador:

# Para clonar o repositório
$ git clone https://github.com/Neki-IT/novo-repo.git

Arquitetura do projeto

O front-end do projeto "nextjs-template" foi elaborado com Next.js e TypeScript.

Ambiente de Desenvolvimento

Tecnologias

Bibliotecas

• Estilização:
  • Tailwind CSS
• Formulários:
  • React Hook Form
  • yup
• Teste:
  • Jest
• Data Fetching:
  • Axios

Conhecimentos necessários

• HTML e CSS
• TypeScript
• Next.js e React

Extensões Necessárias

Como configurar o projeto

Instalação de depêndencias

Execute o comando pnpm em seu terminal para fazer donwload das depêndecias necessarias.

# Para instalar as depêndecias execute
$ pnpm i
# ou também
$ pnpm install

Ambientes

Existem três ambientes distintos que deverão possuir configurações únicas, por isso foram criados arquivos separados para cada, usando dotenv e a metodologia 12-factor.

Rodando o projeto

No terminal do projeto execute o comando pnpm dev para iniciar o mesmo.

# Para rodar o projeto execute o comando
$ pnpm dev