Skip to content
This repository has been archived by the owner on Jun 20, 2023. It is now read-only.

neninja/elefanteca_api

Repository files navigation

elefanteca_api

CI coverage emojicom

Swagger

API de sistema para bibliotecas.

Situação do projeto 📋

Execução local com Docker

Configuração inicial

  1. Duplique .env.example e renomeie para .env

    cp .env.example .env
  2. Mude o usuário (DB_USERNAME), senha (DB_PASSWORD) e JWT (JWT_KEY) de .env

  3. Crie os containers

    docker-compose up -d

    Caso queira, ao final da configuração, pare os containers com docker-compose down

  4. Baixe as dependências do composer

    docker-compose exec app composer install
  5. Crie a chave de criptografia

    docker-compose exec app php artisan key:generate
  6. Crie as tabelas no banco

    docker-compose exec app composer doctrine:migrations migrate
  7. Com o comando para resetar o banco, crie alguns dados básicos para a aplicação ser funcional em um primeiro momento, como por exemplo um usuário admin com email e senha admin@desativemeemprod.com asdf

    docker-compose exec app php artisan db:reset

    Para melhorar o ambiente de desenvolvimento com exemplos, utilize docker-compose exec app php artisan db:reset --development

  8. Crie a documentação de suporte que ficará disponível em localhost:8989/swagger

    docker-compose exec app composer swagger
  9. Dê as permissões necessárias

    docker-compose exec app chmod -R 777 storage

Execução

Com a configuração inicial já realizada, suba os containers se necessário e acesse a aplicação em localhost:8989

docker-compose up -d

Teste

  • Individual

    docker-compose exec app composer test tests/caminho/do/ExemploTest.php
  • Completo

    docker-compose exec app composer ci