https://github.com/rubensdimasjr/api-laravel

API REST de faturas (invoices)
https://github.com/rubensdimasjr/api-laravel

docker-compose laravel php82 rest-api

Last synced: about 1 month ago
JSON representation

API REST de faturas (invoices)

• Host: GitHub
• URL: https://github.com/rubensdimasjr/api-laravel
• Owner: rubensdimasjr
• Created: 2023-07-10T00:25:57.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-10T01:22:48.000Z (over 1 year ago)
• Last Synced: 2024-10-12T13:01:19.319Z (2 months ago)
• Topics: docker-compose, laravel, php82, rest-api
• Language: PHP
• Homepage:
• Size: 160 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Invoices API

A API REST de faturas (invoices) é um exemplo de solução para gerenciar e processar faturas em um sistema. Com o uso de middlewares e autenticação, a API oferece um alto nível de segurança e controle de acesso aos recursos. Ela permite a criação, atualização, exclusão e recuperação de faturas, fornecendo uma documentação simples e intuitiva para integração com outros sistemas. Com essa API, é possível ter uma noção de como automatizar o processo de geração e gerenciamento de faturas, trazendo eficiência e organização para qualquer aplicação.

## Requisitos

- PHP 8.2

- Composer (última versão de preferência)

- Git

- Git Bash (opcional)

- Docker

## Instalação

1. Clone o repositório:

   ```shell

   git clone https://github.com/rubensdimasjr/api-laravel.git && cd api-laravel/

   ```

2. Instale as dependências do projeto usando o Composer:

   ```shell

   composer install

   ```

3. Copie e renomeie o arquivo **.env.example** para **.env**:

   

   ⚠️ Caso você não esteja utilizando o **git bash** como terminal, terá que renomear manualmente o arquivo e executar o comando para gerar a key.

   ```shell

   cp .env.example .env && php artisan key:generate

   ```

5. Instalação via docker:

   

   ⚠️ Antes de executar o script, dê uma olhada no arquivo **docker-compose.yml** e garanta que nenhuma porta esteja sendo usada pelos serviços.

   ```shell

   docker compose build --no-cache && docker compose up -d

   ```

6. Após o container estar ativo, execute as migrações do banco de dados e alimente-o com dados iniciais:

   

   ℹ️ O script abaixo é utilizado para acessar o terminal de um determinado serviço e executar um comando.

   ```shell

   docker compose exec main php artisan migrate --seed

   ```

   O servidor estará pronto em http://localhost:8000.