Skip to content

Projeto desenvolvido durante minha 🎓 graduação com o intuito de facilitar a coleta de produtos ♻ recicláveis na cidade de São Luís ❤

Notifications You must be signed in to change notification settings

AntonioNarcilio/eco

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Logo

docker Node js GitHub repo size license GitHub last commit GitHub language coun GitHub top language


O que é o ECO ❓

O nome Eco ♻ refere-se a uma "abreviação" de ecológico ou ecológica. O Eco é uma "simples" aplicação web desenvolvida com o intuito de facilitar a coleta de resíduos/produtos recicláveis na cidade de São Luís ❤, divulgando não só as empresas que trabalham 👔 nesse ramo como também, ajudando a encontrar os eco pontos 🗺 espalhados na cidade.

Happy
Clique na imagem para visualizar o projeto no figma

🚀 Atualmente na aplicação da para fazer o que ❓

✅ Visualizar os eco pontos ou empresas cadastradas na aplicação;

✅ Visualizar os dados como: nome, endereço, whatsapp ...

✅ Cadastrar um eco ponto;


🚧 Portas utilizadas

Servidor 🌐 Porta 🚪
web 3000
api 3333

⬇️ Utilizando projeto localmente

Atenção: Antes de seguir o passo a passo abaixo lembre-se de instalar o node-js

No diretório desejado execute no terminal o comando abaixo 👇.

git clone https://github.com/AntonioNarcilio/eco.git

Depois entre no diretório eco

cd eco

Primeiro iremos configurar a API, pois nossa aplicação irá se comunicar com ela. Então entre no diretório api

cd api

Então basta executar o comando abaixo para instalar as dependências do API

npm install

Com isso após ter finalizado a instalação de todas as dependências da API basta rodar o comando abaixo 👇 para iniciar

npm start

Pronto 🎊 a API já esta funcionando, você consegue acessar em localhost:3333 (opcional)


Agora abra um novo terminal e entre no diretorio eco para iniciarmos a aplicação Web. E logo em seguida entre no diretório front

cd front

Iremos executar o comando abaixo para instalar as dependências da aplicação

npm install

Logo após ter finalizado a instalação de todas as dependências da aplicação basta rodar o comando abaixo 👇 para iniciar

npm start

Pronto 🎊 a aplicação já esta funcionando, e está consumindo a API que configuramos, agora basta ir no navegador de sua preferência e digitar na barra de endereço localhost:3000 e pronto :).


⬇️ Rodando o Eco com docker 🐳

Atenção: Antes de seguir o passo a passo abaixo lembre-se de instalar o docker

Para executar o projeto através de um container no docker é bem fácil basta executar os comandos

docker pull joaosipauba/eco:1.0
docker pull joaosipauba/ecoapi:1.0

Esses comandos baixarão as imagens referentes ao projeto armazenada em meu repositório. Para visualizar a image basta executar:

docker images

Que ira aparecer algo como

Com isso precisamos criar dois containers para rodar a aplicação, primeiro execute:

docker run --name ecoapi -p 3333:3333 -d joaosipauba/ecoapi:1.0

Em seguida execute:

docker run --name eco -p 3000:3000 -d joaosipauba/eco:1.0

De forma bem direta esse comando irá criar dois containers, o primeiro chamado ecoapi, e o segundo chamdo eco. Os containers rodarão nas porta 3333 e 3000 respectivamente. Para vermos se eles realmente estão funcionando, basta executar o comando abaixo:

docker ps

Que retorná algo como:


Pronto 🎊 a aplicação já esta funcionando, agora basta ir no navegador de sua preferência e digitar na barra de endereço 0.0.0.0:3000 e pronto :).


📜 Licença

Esse projeto está sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.



Created by antonionarcilio e JoaoSipauba 🤓