README.md

Desafio Técnico LinkApi

---

📑 Índice

• 📋 Sobre
• 💻 Tecnologias
• 📑 Requisitos
• 📁 Como instalar
• 👽 Autor

---

📋 Sobre

Esta API é baseada na MockAPI.

Este projeto foi feito com um objetivo - treinar habilidades de desenvolvimento de APIs.

---

💻 Tecnologias

• JavaScript
• NodeJs

---

📦 Dependências

• Express
• Axios
• Nodemon
• DotEnv

---

📑 Requisitos

Para executar este projeto, você precisa do Git e do NodeJs instalado em seu dispositivo. É recomendável usar um editor de código como VsCode.

---

📁 Como Instalar e usar

• Primeiro clone o repositório com o comando abaixo:

    # Usando o Git bash, clone o repositório
    $ git clone https://github.com/GuiFerreira01/Desafio-Tecnico-LinkApi.git

• Depois disso, entre na pasta principal do projeto.

    # Alterando o diretório no terminal/CMD
    $ cd Desafio-Tecnico-LinkApi

• Em seguida, instale todas as dependências usando o comando npm install.

    # Instalando todas as dependências
    $ npm install

• No arquivo .env.exemple, esta o exemplo de como se deve criar o arquivo .env, com a variavel de ambiente.

    # Variavel de ambinete
    $ HOST = 

• No terminal, use o comando npm start para permitir que o projeto seja executado.

    # Iniciando o projeto
    $ npm start

• Em seguida, abra seu navegador ( ou utilize algum programa como o insomnia por exemplo ) e digite a url: localhost:3001

    # O projeto será executado na porta:3001

---

👽 Autor

_{Guilherme S. Ferreira}

Feito com ❤️ por Guilherme S. Ferreira