api-laravel

API RESTful em LARAVEL

📋 Descrição

Este projeto é uma API RESTful desenvolvida em PHP com o framework Laravel, destinada ao gerenciamento de escalas de serviço para militares.

✨ Funcionalidades Principais

• Autenticação de Usuário: Permite que os usuários se registrem e façam login para acessar a aplicação.

🔧 Requisitos do Sistema

• PHP 8.1 ou superior
• Composer
• Node.js e NPM
• SQLITE
• Laravel 10.x

🚀 Instruções de Instalação

Siga os passos abaixo para configurar o ambiente de desenvolvimento:

1️⃣ Configuração do Arquivo de Ambiente

copiar o arquivo env.example e renomear para ".env"

cp .env.example .env

ℹ️ Esta etapa é essencial para a configuração inicial do seu ambiente. O arquivo .env contém todas as variáveis de ambiente necessárias para a aplicação funcionar, como configurações de banco de dados, chaves de API e outras configurações específicas do ambiente.

2️⃣ Geração da Chave da Aplicação

php artisan key:generate

ℹ️ Este comando gera uma chave de aplicação única que é usada pelo Laravel para criptografar sessões, cookies e outros dados sensíveis. Sem esta chave, sua aplicação não funcionará corretamente e ficará vulnerável a ataques.

3️⃣ Execução das Migrações

php artisan migrate

ℹ️ As migrações são responsáveis por criar a estrutura do banco de dados. Este comando executa todas as migrações pendentes, criando tabelas, colunas e índices necessários para o funcionamento do sistema.

4️⃣ Instalação de Dependências JavaScript

npm install

ℹ️ Este comando instala todas as dependências JavaScript do projeto listadas no arquivo package.json. Estas são necessárias para o frontend da aplicação, incluindo bibliotecas como Vue.js, React ou outras frameworks e ferramentas utilizadas no desenvolvimento.

5️⃣ Instalação de Dependências PHP

composer install

ℹ️ O Composer é o gerenciador de dependências do PHP. Este comando instala todas as bibliotecas e pacotes PHP necessários para o funcionamento do backend da aplicação, conforme especificado no arquivo composer.json.

6️⃣ Compilação dos Assets

npm run build

ℹ️ Este comando compila e minimiza os arquivos JavaScript, CSS e outros recursos do frontend, preparando-os para uso em produção. Isso otimiza o desempenho da aplicação ao reduzir o tamanho dos arquivos e combinar múltiplos arquivos em um só.

7️⃣ Executando o Ambiente de Desenvolvimento

Para iniciar o servidor de desenvolvimento, você precisa executar dois comandos em terminais separados:

Terminal 1:

npm run dev

ℹ️ Este comando inicia o servidor de desenvolvimento do Vite, que oferece hot-reloading para seus arquivos frontend, permitindo que você veja suas alterações em tempo real sem precisar recarregar manualmente o navegador.

Terminal 2:

php artisan serve

ℹ️ Este comando inicia um servidor de desenvolvimento PHP local, normalmente disponível em http://localhost:8000. Este é o servidor que processa as requisições PHP e renderiza sua aplicação.

🌐 Acessando a Aplicação

Após seguir todas as etapas acima, você pode acessar a aplicação em seu navegador através do endereço: http://localhost:8000

Publicação das Releases

Para publicar uma nova versão da aplicação, siga os passos abaixo:

Após implementar suas mudanças:

git add .

git npm run commit

git push origin main

Gera nova release e changelog automático

npm run release

Push dos commits e tags

git push --follow-tags origin main

Créditos

Autor Este projeto foi desenvolvido por Hudson Teles.

Sobre o desenvolvedor Sou o criador desta solução, trazendo minha experiência e conhecimento para resolver este problema específico.

Contato:

Email: [e-mail] LinkedIn: Hudson Teles GitHub: @hudsonteles "Developed with dedication by Hudson Teles"