项目作者: grupotesseract

项目描述 :
✨ Boilerplate for creating RESTful APIs and Admin Panel using Laravel, InfyOm, CoreUI and Vessel
高级语言: TSQL
项目地址: git://github.com/grupotesseract/api-boilerplate.git
创建时间: 2018-03-14T17:07:53Z
项目社区:https://github.com/grupotesseract/api-boilerplate

开源协议:

下载


Laravel API Boilerplate


Criado com muito ☕ por Grupo Tesseract

Version 0.1.0



Requisitos ·
Instalação ·
Troubleshooting


Requisitos

  • Docker

    1. curl -fsSL https://get.docker.com | bash
  • Docker Compose

    1. sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
    2. sudo chmod +x /usr/local/bin/docker-compose


Instalação

  1. git clone https://github.com/grupotesseract/api-boilerplate
  2. cd api-boilerplate

É altamente recomendada a criação do alias abaixo. Inclua no seu arquivo ~/.zshrc ou ~/.bashrc:

  1. alias v='./vessel'

Em seguida, com o alias acima habilitado no terminal, executar:

  1. cp .env.example .env
  2. v start
  3. v comp i
  4. v art key:generate
  5. v art migrate --seed
  6. v art passport:install
  7. v y
  8. v y watch

A partir de agora, você já deve conseguir visualizar a página inicial através do endereço http://localhost/. Tente efetuar login através do acesso:

  1. Email: admin@grupotesseract.com.br
  2. Senha: admin


Comando para gerar um CRUD

  • Criar arquivo na pasta database/model_schemas referente a entidade desejada. Nesta pasta, é possível visualizar exemplos de como criar a entidade e seus relacionamentos;
  • Executar o comando abaixo ao gerar algum CRUD, para gerar factories, seeds, e deixar os nomes das rotas e views semânticos de acordo com o plural. SUBSTITUIR a entidade de exemplo com o nome da nova entidade a ser criada, assim como o novo arquivo relacionado criado
  1. v art \
  2. infyom:api_scaffold Cidade \
  3. --tableName=cidades \
  4. --plural=cidades \
  5. --fieldsFile=Cidade.json \
  6. --datatables=true \
  7. --factory \
  8. --seeder


Testes

Para rodar os testes, executar:

  1. v test tests
  • Sendo test o comando do Vessel
  • E tests a pasta de testes da raiz do projeto


Troubleshooting

  • Caso encontre problemas ao iniciar o ambiente, talvez seja necessário verificar as versões do Docker e do Docker Compose. Verifique as versões com:

    1. docker -v # Docker version 20.10.14, build a224086
    2. docker-compose -v # docker-compose version 1.29.2, build 5becea4c

    Caso tenha problemas, você pode utilizar as mesmas versões que citamos em Requisitos.

  • A partir do Docker 18.09, a nova arquitetura de build BuildKit passou a ser utilizada, e o mesmo não está 100% compatível com o projeto no momento. Verifique se o BuildKit está habilitado nos arquivos ~/.docker/config.json ou /etc/docker/daemon.json. Algo como:

    1. {
    2. "features": {
    3. "buildkit": true
    4. }
    5. }

    Se estiver true, altere para false e reinicie o serviço do Docker com:

    1. sudo service docker restart

    Ou o comando da sua distro de preferência.

  • Pode ser também que nada disso resolveu, então recomendamos fazer uma limpeza completa no seu Docker (CUIDADO: esse comando vai deletar tudo do Docker: containers, imagens, volumes e networks)

    1. docker system prune -a -f

    Alguns bons gigabytes serão liberados após esse comando.