Rastreador de Combate para Masmorras e Dragões (D&D) 5ª Edição

O aplicativo oficial da Iniciativa Melhorada vive em https://www.improved-initiative.com

Desenvolvimento Local

Requisitos

• Nó.js (v12+)

Setup

• Clique o reporte para uma pasta no seu computador
• Abra a pasta clonada em um editor de código como o Visual Studio Code
• Abra uma janela de terminal (Powershell é a aplicação de terminal recomendada para este projeto)
• Executar os seguintes comandos na janela de Terminal para construir o código do ambiente do dev:

npm installnpx grunt

• Para colocar o servidor dev em execução, você pode:
  • Pressionar F5 em Visual Studio Code ou
  • Em uma nova janela de terminal executar npm run start
• Após o servidor estar em execução, visite http://localhost em um navegador web para ver uma versão de desenvolvimento da interface que responde às suas alterações de código.
• Sempre que você fizer uma alteração, espere que ela termine de compilar e depois recarregue manualmente seu navegador.

Desenvolvimento de Iniciativa Melhorada é suportado através do Patreon.

Para saber mais sobre como contribuir com código para Iniciativa Melhorada, consulte CONTRIBUIÇÃO.md.

Linting

Improved Initiative usa o Eslint com mais bonito para lintar os arquivos de código.

Linting acontece automaticamente no commit, mas você também pode executá-lo manualmente via: npm run lint.

Configurações da aplicação

Você pode configurar sua instância de Improved Initiative com estas configurações. Todas são opcionais, a funcionalidade básica deve funcionar se você não especificar nenhuma.

• PORT – Padrões para 80
• NODE_ENV – Definido para “produção” para satisfazer reação, definido para “desenvolvimento” para desabilitar html view caching.
• BASE_URL – Usado em URLs absolutas no lado do cliente. Cai de volta para urls relativas se não estiverem disponíveis. Este é o URL canônico para Patreon callback e localStorage.
• SESSION_SECRET – Usado para manter a continuidade da sessão através de reinícios de aplicativos ou algo assim. Entregue para express-session.
• DEFAULT_ACCOUNT_LEVEL – Definido para “accountsync” ou “epicinitiative” para conceder recompensas a todos os usuários. Útil se você não tiver DB.
• DEFAULT_PATREON_ID – Defina o id do usuário do Patreon fictício ao executar com DEFAULT_ACCOUNT_LEVEL set.
• DB_CONNECTION_STRING – Forneça uma string de conexão DB para armazenamento de sessão e conta de usuário. Na memória Mongo DB será usado de outra forma, que é apagada no reinício da aplicação.
• METRICS_DB_CONNECTION_STRING – Fornecer uma string de conexão DB para escrever métricas para.
• PATREON_URL, PATREON_CLIENT_ID, PATREON_CLIENT_SECRET – Configuração para integração Patreon

Docker

Executar Iniciativa Melhorada dentro do Docker é possível, mas completamente opcional e atualmente experimental. Proceda com cautela e quando em dúvida, consulte a documentação do Docker.

Construir a Docker Image

Para construir a imagem da doca com uma build de desenvolvimento, execute:

docker build -t improved-initiative:latest .

Para construir a imagem com uma build de produção, execute:

docker build --build-arg NODE_ENV=production -t improved-initiative:prod .

Executar a aplicação num contentor de doca

Para iniciar a aplicação dentro do contentor, corra:

docker run -p80:80 --name improved-initiative improved-initiative:latest

Or, para executar o build de produção:

docker run -p80:80 --name improved-initiative improved-initiative:prod

Parar e Remover o Container

Assumindo que você iniciou o container com o nome improved-initiative como mostrado acima, os seguintes comandos irão parar o container e então removê-lo:

docker stop improved-initiative

docker rm improved-initiative

Licença

O aplicativo Improved Initiative é disponibilizado sob a licença do MIT.