From 965f60ff2a6eba1d6c196cb0f37b5ea783d3c370 Mon Sep 17 00:00:00 2001 From: gugahnstn Date: Mon, 2 Oct 2023 16:19:15 -0300 Subject: [PATCH] update README --- README.md | 31 +++++++++++++++++++++++++++++-- 1 file changed, 29 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 2424681..b1bbb39 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,29 @@ -# Ipcats - Pesquisador de Ips e dominios. -VALEU RAPAZIADA!! +# Ipcats - Busque as informações de um Ip e dominio. + + +O IPCats é um site dedicado à busca de informações de IPs e domínios. Nosso sistema oferece uma ampla gama de recursos, incluindo uma funcionalidade de pesquisa abrangente e um mapa que indica a localização do provedor do IP ou domínio em questão. + +Para construir esta aplicação, utilizamos a biblioteca React, uma ferramenta poderosíssima para a criação de interfaces. Neste projeto, utilizamos a API do [my-ip-address](https://my-ip-address.bohr.io/api) em conjunto com uma proxy da API [IP-API](https://ip-api.com/). Além disso, Foi utilizado o [Mapbox](https://www.mapbox.com/) para o mapa do site. + +Nossa missão é fornecer uma plataforma confiável e fácil de usar para aqueles que desejam acessar informações relacionadas a IPs e domínios, e continuamos a aprimorar e expandir nossos recursos para melhor atender às necessidades dos nossos usuários. + +Caso queira testar o projeto em sua máquina, utilize os seguinte comandos no terminal: + +```sh +npm install ou yarn install +``` + +Ambiente de Desenvolvimento: +```sh +npm run dev ou yarn dev +``` + +Para construir os arquivos do Projeto: +```sh +npm run build ou yarn build +``` + +Para Iniciar o Projeto: +```sh +npm run start ou yarn start +```