Configuração de Ambiente de Desenvolvimento

1. Objetivo

Fornecer um guia detalhado para configurar o ambiente de desenvolvimento utilizado em projetos da SEDECTI de Tefé, garantindo padronização, segurança e eficiência no trabalho das equipes técnicas.

2. Pré-requisitos

• Computador com sistema operacional Windows, Linux ou macOS.
• Permissão de administrador para instalar softwares.
• Acesso à internet para download de ferramentas e dependências.

3. Instalação de Ferramentas Essenciais

3.1. Editor de Código

• Recomenda-se o uso do Visual Studio Code (VSCode).
• Alternativas: Sublime Text, PHPStorm ou outro editor de preferência da equipe.

3.2. Versionamento de Código

• Instalar o Git para controle de versões.
• Configurar nome e email do usuário:

  git config --global user.name "Seu Nome"
  git config --global user.email "[email protected]"
  

• Opcional: instalar GitHub Desktop ou utilizar integração nativa do VSCode.

3.3. Ferramentas de Linha de Comando

• Windows: Instalar o Git Bash ou Windows Terminal.
• Linux/macOS: Utilizar terminal nativo.

3.4. Gerenciador de Pacotes

• Node.js: Baixar a versão LTS do site oficial nodejs.org.
• npm: Instalado automaticamente com o Node.js.
• Composer (para projetos PHP): getcomposer.org.

3.5. Servidor Local

• XAMPP ou Laragon (Windows) / MAMP (macOS) / LAMP (Linux) para projetos PHP.
• Configurar os serviços necessários: Apache/Nginx, MySQL/MariaDB.

3.6. Banco de Dados

• Instalar e configurar phpMyAdmin ou Adminer para gerenciamento visual do banco de dados.

4. Configuração do Projeto

4.1. Clone do Repositório

• Acesse o repositório oficial do projeto.
• Faça o clone com o comando:

  git clone https://github.com/sedecti/projeto-exemplo.git
  

• Acesse a pasta do projeto:

  cd projeto-exemplo
  

4.2. Instalação de Dependências

• Para projetos Node.js:

  npm install
  

• Para projetos PHP:

  composer install
  

4.3. Configuração de Variáveis de Ambiente

• Copie o arquivo de exemplo:

  cp .env.example .env
  

• Edite o arquivo .env conforme as necessidades do projeto (dados do banco, API keys, etc.).

4.4. Configuração do Banco de Dados

• Crie um novo banco de dados local.
• Importe o arquivo de estrutura/dados fornecido, se aplicável.
• Atualize as configurações no arquivo .env ou de acordo com o framework utilizado.

5. Padronização de Código

• Sempre utilize branchs para novas funcionalidades ou correções.
• Siga o padrão de nomenclatura definido pelo time.
• Execute ferramentas de lint e formatação antes de enviar código (prettier, eslint, php-cs-fixer, etc.).

6. Testes Locais

• Realize testes unitários, de integração e manuais sempre que possível.
• Corrija eventuais erros antes de abrir Pull Requests.

7. Segurança

• Nunca exponha senhas ou chaves de API em repositórios públicos.
• Utilize arquivos .env para configurações sensíveis.
• Revise permissões de pastas e arquivos no ambiente local.

8. Documentação

• Mantenha o README.md atualizado com instruções relevantes.
• Documente qualquer configuração especial ou dependência adicional.

9. Suporte e Dúvidas

• Em caso de dúvidas, consulte a documentação oficial do projeto ou entre em contato com o responsável técnico da SEDECTI.

Seguindo este guia, cada membro da equipe poderá preparar seu ambiente de desenvolvimento de maneira rápida, segura e padronizada, contribuindo para a eficiência dos projetos da SEDECTI.