https://github.com/magrathealabs/jarvis

:robot: Just A Rather Very Intelligent System
https://github.com/magrathealabs/jarvis

Last synced: about 2 months ago
JSON representation

:robot: Just A Rather Very Intelligent System

• Host: GitHub
• URL: https://github.com/magrathealabs/jarvis
• Owner: magrathealabs
• Created: 2019-07-22T15:46:48.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-08-06T19:19:33.000Z (over 5 years ago)
• Last Synced: 2024-10-31T14:05:28.071Z (about 2 months ago)
• Language: Go
• Size: 4.35 MB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Coverage Status](https://coveralls.io/repos/github/magrathealabs/jarvis/badge.svg)](https://coveralls.io/github/magrathealabs/jarvis)

[![Build Status](https://travis-ci.org/magrathealabs/jarvis.svg?branch=master)](https://travis-ci.org/magrathealabs/jarvis)

# Jarvis :robot:

Apenas um sistema bastante inteligente para controlar o nosso dia-a-dia de trabalho físico e remoto.

## Variáveis de Ambiente - Jarvis

Servidor WEB:

```sh

    $WEB_HOST=0.0.0.0

    $WEB_PORT=3000

```

Postgres:

```sh

    $POSTGRES_HOST=localhost

    $POSTGRES_USER=postgres

    $POSTGRES_PASS=postgres

    $POSTGRES_DBNAME=test

    $POSTGRES_PORT=5432

```

Graphite:

```sh

    $METRIC_HOST=localhost

    $METRIC_PORT=2003

```

## Serviços Externos

 - Postgres: Banco de Dados para dados consistêntes do Jarvis

 - Graphite: Banco de Dados para métricas do Jarvis

   - Grafana: Usado para visualização do Grafite (Não necessário)

 - RabbitMQ: Fila para requisições `mqtt` dos serviços de IOT.

## Dev

Utilizamos Makefile & Docker & Docker-Compose para automatizar o fluxo de trabalho:

 - `make up`: Executa toda a infraestrutura com o código fonte local para executar o ambiente de dev.

 - `make dev`: Sobe somente os serviços de dependência para executar testes unitários no VisualCode.

 - `make test`: Executa toda a suite de testes. Utilizamos a infraestrutura Docker para executar os testes.

O Jarvis está construído sobre o Golang 1.12. Lembre-se que é opcional caso queira somente executar o ambiente `make up`, visto que este executa dentro do docker. Pode instalar da seguinte forma:

```sh

    bash < <(curl -s -S -L https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer)

    gvm install go1.12 -B

    gvm use go1.12

```

Caso queira alterar, recomendamos clonar dentro do $GOPATH para a IDE executar testes e obter a tipagem de forma correta:

```sh

    mkdir -p $GOPATH/src/github.com/magrathealabs/

    cd $GOPATH/src/github.com/magrathealabs/

    git clone [email protected]:magrathealabs/jarvis.git

```

Para atualizar ou obter nvoas dependências, utilizamos o Govendor:

```sh

    go get -u github.com/kardianos/govendor

```

Para verificar a qualidade do código, utilizamos o Golint-CI:

```sh

    go get -u github.com/golangci/golangci-lint/cmd/golangci-lint

    golangci-lint run

```