INSTALLING.md

Instalação

Essas instruções vão te levar a uma cópia do projeto rodando em sua máquina local para propósitos de testes e desenvolvimento.

Tabela de conteúdos

• Instalação padrão
• Instalação com Docker

Instalação padrão

Pré-requisitos

• Node.js versão 12 ou superior
• Gerenciador de pacotes (Yarn ou NPM)
• Uma instância local ou um cluster do MongoDB rodando

Clonando o repositório

$ git clone https://github.com/Lorenalgm/DevChallengeAPI.git

$ cd DevChallengeAPI

Ou se preferir, faça o download do projeto.

Instalando dependências

$ yarn

ou

$ npm install

Configurando as variáveis de ambiente

(OPCIONAL) Crie um arquivo na raiz do projeto chavado .env.

APP_URL={A URL em que o seu app está hospedado}

MONGO_URL={Sua string de conexão do MongoDB}

Por padrão, o arquivo .env.development já vem com variáveis de ambiente pré-definidas para um ambiente de desenvolvimento.

Iniciando uma instância local

$ yarn dev

ou

$ npm run dev

E você está pronto para ir!

Instalação com Docker

Por padrão, instalar o projeto com o Docker Compose o inicializará como um ambiente de desenvolvimento.

Pré-requisitos

• Docker
• Docker Compose

Clonando o repositório

$ git clone https://github.com/Lorenalgm/DevChallengeAPI.git

$ cd DevChallengeAPI

Ou se preferir, faça o download do projeto.

Inicializando os contêineres

$ docker-compose build && docker-compose up -d

Nota: O servidor e a instância do MongoDB estará rodando nas portas 3001 e 3002, respectivamente.

E você está pronto para ir!