Git Product home page Git Product logo

emcash-polygon's Introduction

EmCash - Júnior Backend Test

Este é um teste para a vaga de desenvolvedor backend júnior na EmCash. A finalidade do teste é criar uma API para o cadastro de triângulos e retângulos, e obter a soma total da área de todos os polígonos cadastrados no sistema.

Configuração do Projeto

Siga as instruções abaixo para configurar e executar o projeto em sua máquina.

Pré-requisitos

  • Git
  • Docker (opcional)
  • Composer
  • PHP

Instalação

    # Clone o repositório
    > git clone https://github.com/Casmei/emcash-polygon.git

    # Acesse a pasta do projeto
    > cd emcash-polygon

    # Crie o arquivo de configuração das variáveis de ambiente (Linux)
    > cp .env.example .env

    # Crie o arquivo de configuração das variáveis de ambiente (Windows)
    > copy .env.example .env

Iniciando com Docker (😊 Happy path )

Se você tiver o Docker instalado em sua máquina, pode seguir estes passos:

    # Construa os containers
    > docker compose up --build

Iniciando sem Docker

Se você não tiver o Docker instalado, siga estes passos:

    # Instale as dependências do projeto com o Composer
    > composer install

    # Gere a chave de segurança requisitada pelo Laravel
    > php artisan key:generate

    # Execute as migrações do banco de dados ( Valide nas envs as credenciais de conexão com o banco caso dê erro )
    > php artisan migrate

    # Inicie o sistema
    > php artisan serve

Documentação

A documentação do projeto é feita utilizando o Swagger. Para acessar a documentação, basta abrir o seguinte URL no seu navegador:

http://127.0.0.1:8000/api/documentation

Rotas

Verbo Http Rota Parâmetros
POST api/triangles base, side1, side2
POST api/rectangles base, height
GET api/total-area

Testes

Para executar os testes de integração e unitários, utilize o seguinte comando:

Com Docker

    # Entre no container da aplicação
    > docker exec -itu 0 emcash-polygon-main-1 sh

    # Execute os testes
    > php artisan test

Sem o Docker

    # Execute os testes
    > php artisan test

emcash-polygon's People

Contributors

casmei avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.