README_PT_BR.md

Atena v.0.2

English Documentation

A Atena é uma iniciativa da Impulso Network em colaboração com vários Impulsers, com o objetivo de promover o engajamento e recompensar as atividades e esforços de cada pessoa na Impulso. Nele você poderá adquirir Pontos de Experiência (XP) através da execução de diversas atividades e com base nesses dois fatores os Impulsers receberão níveis e conquistas, reconhecendo o esforço despendido nas atividades.

Integrações

A Atena hoje possui integrações com:

• Github
• Worpress

Configuração

Segue um passo-a-passo da configuração mínima que você precisa para obter o Atena em execução:

Configuração inicial

• Ter instalado o Mongodb
• Ter instalado o Yarn

Desenvolvimento

• Faça um fork do projeto para a tua conta
• Então, faça o clone:

> git clone https://github.com/{sua-conta}/atena

• Navegue até a pasta de destino onde fez o clone do projeto:

> cd atena/

• Instale as dependências utilizando o yarn:

> yarn -i

• Adicionar referências remotas da Atena:

> git remote add upstream https://github.com/universoimpulso/atena

• Criar o arquivo .env na raiz do projeto com as suas configurações copiando e renomeando o arquivo .env.example e, posteriormente, alterando alguns valores citados abaixo.

Configurando a integração com Github

Para utilizar a integração do Github, siga os passos da documentação, clicando aqui.

Configurando a integração com Wordpress

Para utilizar a integração do Wordpress, siga os passos da documentação, clicando aqui.

Executando em ambiente de desenvolvimento

• Inicie o servidor utilizando o seguinte comando:

> yarn start:dev

Debug

Caso deseje usar um debug, em um terminal inicie o servidor com o seguinte comando:

> yarn start:dev:debug

Rode o node inspect em outra janela de terminal:

> node-inspect localhost:9229

Contribuindo

O principal objetivo deste repositório é continuar a evoluir o Atena, tornando-o mais rápido e fácil de usar.

O desenvolvimento da Atena acontece a céu aberto no GitHub, e somos gratos à comunidade por contribuir com correções de bugs e melhorias. Leia abaixo para saber como você pode participar da melhoria da Atena e da Impulso network.

Código de Conduta

A Impulso Network adotou um Código de Conduta que esperamos que os participantes do projeto sigam. Por favor, leia Código de Conduta para que você possa entender quais ações serão e não serão toleradas.

Guia de Contribuição

Leia nosso guia de contribuição para conhecer nosso processo de desenvolvimento, como propor correções de erros e melhorias, e como construir e testar suas alterações no Atena.

Comunidade

Todos os comentários e sugestões são bem-vindos e podem ser feitos via Issues no Github

💬 Junte-se a comunidade em Impulso Network

License

Este projeto está licenciado sob a licença MIT - consulte o arquivo LICENSE para obter detalhes.