Skip to content

Leandro2585/students-api-graphql

Repository files navigation

GitHub language count Repository size GitHub last commit License Stargazers Feito por Leandro

🚧 Students Api GraphQL - Em Desenvolvimento 🚀 🚧

SobreComo executarTecnologiasAutorLicença

💻 Sobre o projeto

Students Api GraphQL - É um projeto que lista alunos através de filtros como CPF, Email ou Nome.


🚀 Como executar o projeto

Esse template foi desenvolvido com Typescript, portanto certifique-se de que é usual para o seu contexto antes de fazer a instalação.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Server

# Clone este repositório
$ git clone git@github.com:Leandro2585/students-api-graphql.git

# Vá para a pasta server
$ cd students-api-graphql

# Execute sua aplicação utilizando o docker utilizando o comando 'up'
$ yarn up

# O servidor inciará na porta:3333 - acesse http://localhost:3333

💪 Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
  4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub


Autor


Leandro Real
🚀

📝 Licença

Este projeto esta sobe a licença MIT.

Desenvolvido por Leandro Real 👋🏽 Entre em contato!