DevCollective.io

DevCollective.io

Desenvolvimento local

1. Instale o docker

Você precisará instalar o Docker para ativar o Postgres. Usuários do Windows, certifique -se de instalar extensões WSL2, conforme necessário para que o Postgres funcione corretamente.

2. Instale o fio

Por vários motivos, este projeto depende do fio. Você pode instalá -lo usando:

npm install -g yarn

3. Instalação de fios

Isso instalará suas dependências.

yarn

4. Inicie seu banco de dados

yarn dbup

Esta etapa cria 2 bancos de dados Postgres no Docker. O da porta 10800 é o desenvolvimento, enquanto o da porta 10801 é para testes de unidade.

Usuários do Windows:

Se você vir este erro:

 The command 'docker-compose' could not be found in this WSL 2 distro.

Em seguida, verifique se na área de trabalho do Docker em Configurações/Geral de "usar o mecanismo baseado no WSL 2" está verificado.

5. Corra intocado para criar todos os seus bancos de dados.

Temos um comando conveniente, yarn pristine , que recria e re-semeia o banco de dados. Você pode usar este comando a qualquer momento para limpar seu banco de dados e redefini -lo.

yarn pristine

Execute intocado toda vez que o banco de dados muda.

O Pristine deve ser executado após cada mudança de banco de dados para atualizar seu banco de dados com as mais recentes migrações.

Pristine pode ser usado para redefinir seu banco de dados

O Pristine pode ser executado a qualquer momento para redefinir seu banco de dados para um estado limpo. Isso pode ser útil em muitas situações.

Se você encontrar problemas que o Pristine não resolve

Se você encontrar problemas mais profundos, poderá destruir suas instâncias do PostGres e começar do arranhão absoluto. Existe um comando que destruirá todas as imagens do Docker, recipientes, volumes que não estão em execução no momento. Primeiro, você deseja interromper todos os processos do Docker relacionados a este projeto e, em seguida, execute docker system prune -a . Nota: Este é um comando perigoso que destruirá tudo o que não está em execução no Docker, incluindo nenhum projeto que não seja dc.io.

6. Declare o número da porta personalizado para iniciar o aplicativo

** A criação deste arquivo é opcional. Se você não criar esse arquivo no ambiente de dev, os valores padrão serão usados ​​no arquivo dev.env presente na pasta Dev.

Primeiro, crie o arquivo dev-override.env na pasta dev presente no diretório raiz. Em seguida, copie e cole os seguintes campos em seu arquivo.

 PORT= *

No lugar de * você pode declarar seu próprio número de porta disponível em sua máquina.

7. Inicie seu servidor

Por fim, você pode executar o comando yarn dev (Windows: yarn dev:win ) para iniciar o servidor. Isso servirá ao front -end e ao back -end na porta 3000.

8. Opcional: configure extensões VSCode

O menu depuração do VSCode, que depende do Launch.Json, foi preenchido com algumas opções de corrida. Um executa o servidor, enquanto o outro executa os testes de unidade. Ambos são ativados com pontos de interrupção e podem ser uma ótima maneira de depurar seu código quando necessário.

Este projeto está configurado para jogar bem com o VSCODE JEST. Ele executará seus testes em segundo plano e também fornecerá botões úteis de "depuração" para testes específicos. Altamente recomendado para qualquer trabalho de back -end.

A instalação do VSCODE GraphQL permite o destaque da sintaxe do GraphQL. Recomendado para o trabalho GQL.

Documentos úteis

Como fazer seu primeiro pedido de puxão - obrigado, Julio Alcantara! Como criar novas entidades como sincronizar seu repo com código atualizado

Config de produção

Se for implantar na produção, primeiro coloque seus arquivos de configuração em /etc/mintbean-v4/config/* . Em seguida, execute yarn start .