sandronister/gama-coders-backend

challenge gama academy

Descrição

Projeto desenvolvido durante o evento de aceleração em NodeJS promovido pela Gama Academy.

Pré requisitos

Para rodar o projeto, você precisará de algumas dependências previamente instaladas:

• NodeJS
• Yarn ou NPM

Clonando o repositório

Para baixar o repositório localmente, basta utilizar o seguinte comando em seu terminal de preferência:

$ git clone https://github.com/sandronister/gama-coders-backend.git

Instalando dependências

Após clonar o repositório, você precisará instalar as dependências do projeto.

Para isso, basta navegar até a pasta do projeto e rodar o seguinte comando

$ cd ./gama-coders-backend

# para Yarn
$ yarn

# para NPM
$ npm install

Rodando o projeto

Uma vez que instalada todas as dependências, você já pode rodar a aplicação! Basta utilizar o comando:

# para Yarn
$ yarn start

# para NPM
$ npm start

Por padrão, a aplicação irá rodar na porta 3001.

Testes

Para rodar os testes do projeto, basta utilizar os comandos:

# test coverage
$ yarn test:cov

# unit tests
$ yarn test

# caso utilize NPM, basta trocar a palavra "yarn" por "npm" nos comandos