Code Monkey home page Code Monkey logo

api-weather-challenge's Introduction

API-WEATHER-CHALLENGE

Arquitetura em camadas

├── .env                                      <- Arquivo de configuração de ambiente
├── src                                       <- Código fonte do projeto
|   ├── http                                  <- Pasta com as configurações da camada de http
|   |   ├── app.ts                            <- Configurações para o uso do express
|   |   ├── middlewares.ts                    <- Middlewares do express
|   |   ├── routes.ts                         <- Arquivo que contém as rotas do projeto
|   ├── modules                               <- Pasta que contém os modulos do projeto
|   |   ├── <nome_modulo>                     <- Módulo 
|   |   |   ├── index.ts                      <- Factory para criar as instâncias das classes que serão expostas
|   |   |   ├── <nome>.controller.ts          <- Classe controlladora do módulo
|   |   |   ├── <nome>.dto.ts                 <- Interfaces para troca de informações entre objetos
|   |   |   ├── <nome>.service.ts             <- Arquivo que executa a regra de negócio
|   |   |   ├── <nome>.validator.ts           <- Arquivo para validação da requisição
|   |   ├── index.ts                          <- Arquivo para expor os módulos
|   ├── providers                             <- Pasta contendo as bibliotecas utilizadas
|   ├── shared                                <- Pasta com abstrações que podem ser utilizadas em diferentes módulos
|   |   ├── controllers                       <- Contém os arquivos controladores com abstrações
|   |   ├── helpers                           <- Contém os arquivos de ajuda que podem ser utilizados em diferentes módulos
|   |   |   ├── env.helper.ts                 <- Arquivo com o valor default das variáveis utilizadas na aplicação
|   |   |   ├── http-response.helper.ts       <- Arquivo para padronizar as respostas da aplicação
|   |   ├── services                          <- Contém os serviços que podem ser utilizados em diferentes módulos
|   ├── server.ts                             <- Arquivo para inicializar o servidor
├── request-log.log                           <- Arquivo gerado com os logs das requisições

Instalar as dependências

  • npm i;

Iniciar a aplicação no ambiente local

  • Utilizar o arquivo .env caso queira alterar o valor default de alguma variável de ambiente;
  • Executar o comando npm run docker:local para subir serviços dependentes;
  • Executar o comando npm start para inicializar o servidor;

Documentação da API

Link

api-weather-challenge's People

Contributors

tiagocambaravs avatar

Watchers

James Cloos 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.