coderogers / api-pets

Nome do projeto

Um CRUD simples de clientes e pets só para registro e leitura com um relacionamento One to Many entre Client e Pet

💻 Pré-requisitos

Antes de começar, verifique se você atendeu aos seguintes requisitos:

• Você instalou a versão mais recente do NodeJS.
• Você tem uma máquina Windows / Linux / Mac.
• Você leu seguiu corretamente o passo a passo de instalação.

🚀 Instalando API-Pets

• Instalando:

Dentro da pasta do projeto através do terminal execute o seguinte comando:

$ npm i

☕ Usando API-Pets

Inicializando:

npm run start

Após inicializada você pode utilizar uma ferramenta de requisições, como por exemplo Insomnia, para simular requisições para a API através das rotas encontradas no arquivo routes.ts, ou mesmo conectar-se através de seu projeto FrontEnd enviando requisições para as rotas anteriormente citadas.

Adicione comandos de execução e exemplos que você acha que os usuários acharão úteis. Fornece uma referência de opções para pontos de bônus!

📫 Contribuindo para API-Pets

1. Bifurque este repositório.
2. Crie um branch: git checkout -b <nome_branch>.
3. Faça suas alterações e confirme-as: git commit -m '<mensagem_commit>'
4. Envie para o branch original: git push origin <nome_do_projeto> / <local>
5. Crie a solicitação de pull.

Como alternativa, consulte a documentação do GitHub em como criar uma solicitação pull.

🤝 Colaboradores

Rogério Venâncio

📝 Licença

ISC

⬆ Voltar ao topo