/boilerplate-gql

Boilerplate para desenvolvimento de uma API GraphQL.

Primary LanguageJavaScript

Boilerplate GraphQL

Coverage Status

Boilerplate para desenvolvimento de uma API GraphQL.

Instalação

⚠️ Importante

Instale o Yarn.

npm install -g yarn
yarn set version stable

Use o degit para fazer o scaffolding do projeto.

Existem algumas dependências.

Exemplo:

yarn dlx degit lagden/boilerplate-gql#main projeto
cd projeto
yarn dlx degit lagden/boilerplate-bin/files#main bin
yarn dlx degit lagden/boilerplate-eslint/files/backend/.eslintrc.yml#main ./.eslintrc.yml --force
yarn dlx degit lagden/boilerplate-envs/files#main ./ --force
yarn dlx degit lagden/boilerplate-docker-nodejs/files#main ./ --force

Como utilizar

Após finalizado o scaffolding do projeto, instale os pacotes.

bin/node/zera -y

Feito isso, o projeto está pronto para rodar.

Se for rodar local, utilize:

bin/local/start

Se for rodar via docker, utilize:

bin/docker/start

⚠️ Ressalvas

No docker, caso seja instalado um novo pacote, é necessário fazer o build da imagem novamente.
Pare o container (bin/docker/stop ou command + c ou control + c) e rode novamente passando o parâmetro -b:

bin/docker/start -b

watch

O watch reinicia a aplicação caso ocorra alguma alteração.
Rodando via docker isso ocorre por padrão, mas local é necessário fazer algumas instalações e configurações.

entr

Se estiver rodando em BSD ou Mac OS ou Linux, basta instalar o entr e executar:

bin/local/watch

nodemon

Como o entr não roda no Windows, existe uma solução alternativa.

Crie o arquivo .env-local na raiz do projeto e insira:

WATCH_LOCAL_CMD="yarn dlx nodemon -e js,json --watch server --exec npm start"

⚠️ Ressalvas

Pode instalar global também e configurar da seguinte forma:

WATCH_LOCAL_CMD="nodemon -e js,json --watch server --exec npm start"

Então, execute o comando:

bin/local/watch

teste

Para executar os testes.

local:

bin/local/test

docker:

bin/docker/test -s app

Imagem

Crie os arquivos de usuário e senha do registry que serão utilizados.

echo 'username' > .registry-user
echo 'password' > .registry-passwd

Verifique as suas variáveis de ambiente .env-*.
E para fazer o push da imagem de sua aplicação, execute:

bin/docker/image -e production

⚠️ Ressalvas

Se o parâmetro -e não for definido, o padrão é staging.

Deploy

Para executar o deploy é necessário alguns binários instalados:

  • envsubst by Bruno Haible
  • rsync by Andrew Tridgell, Wayne Davison and others

O fluxo do sistema de deploy é simples:

  1. Carrega as variáveis de ambiente (staging ou production)
  2. Executa o script bin/docker/image (se passado o parâmetro -i esse processo é ignorado)
  3. Cria o arquivo docker-compose-{VERSION}.yml utilizando o envsubst
  4. Envia os arquivos para o servidor via rsync
  5. Executa o docker stack deploy no servidor
bin/docker/deploy -e production

Exemplo

Chamada de exemplo da API via curl.

curl 'http://[::1]:5000/gql' \
-H 'content-type: application/json' \
-d '{
  "source": "query Hello($name: String!) { hello(name: $name) }",
  "variableValues": {"name": "Sabrina"},
  "operationName": "Hello"
}'

Middlewares

Sugestão de outros middlewares para serem utilizados no projeto:

License

MIT © Thiago Lagden