Eu Ajudo 💜

Eu ajudo | Venha ajudar sua comunidade! 💜

📖 Sobre

O projeto 'Eu ajudo' é uma aplicação Web realizada para que os usuários colabore com sua comunidade cadstrando os pontos de vacina em sua cidade no site. Assim que outras pessoas possam encontrar.

Encontrar ou tornar visíveis os pontos de ajudas nunca foi tão fácil. Comece a Encontrar ou Adicionar um novo ponto de vacinação ou de doações. Temos como propósito que apropria comunidade se ajude entre si, assim colaborando na sociedade. Então venha ajudar sua comunidade!💜

Realizado através do projeto do Trabalho de conclusão de curso (TCC) pelo Instituto Federal de Educação Ciência e Tecnologia da Paraíba Campus Picuí (IFPB). 🎓

🎓 Membros

Rômulo Costa Orientador

Kayo Ronald Front-end

Gluaber Back-end

Eu Ajudo, venha participar você também!

---

🤔 Como contribuir?

• Faça um fork desse repositório;

• Cria uma branch com a sua feature: git checkout -b minha-feature;

• Faça commit das suas alterações: git commit -m 'feat: Minha nova feature';

• Faça push para a sua branch: git push origin minha-feature.

💻 Tecnologias e Dependência

Esse projeto foi feito utilizando as seguintes tecnologias:

• React.js

• React-helmet

• Chakra-ui

• Styled Components

• TypeScript

• Docker

---

🚀 Como rodar o projeto?

Pré-requisito

• É necessário possuir o Node.js instalado no computador (recomendado a versão LTS).

• Também, é preciso ter um gerenciador de pacotes o npm e npx já vem por padrão ao instalar o node.j ou Yarn.

• É necessário possuir o Git instalado e configurado no computador.

1. Faça um clone do repositório:

Primeiro: é necessário fazer o clone do repositorio após ter feito o fork do projeto para você poder pegar a URL do proejeto como é mostrado no Exemplo 1. E ao final colocar o .git, sendo representando no Exemplo 2. Exemplo 1:

  https://github.com/KayoRonald/euajudo-app

Exemplo 2:

 git clone https://github.com/KayoRonald/euajudo-app.git

2. Executando a Aplicação:

Abrindo o terminal, você pode executar o seguinte comando para entrar no diretório do projeto:

  cd euajudo-app 

3. Como instalar as dependências

Caso você queira, podera ser usado o yarn ou npm.

yarn 

npm install

4. Como rodar o projeto

yarn start

npm start

Ao inicia o projeto abrirar a rota localhost:3000

---

Docker

docker build -t euajudo:dev .

docker run -v ${PWD}:/app -v /app/node_modules -p 3001:3000 --rm euajudo:dev

---

📷 Imagens utilizadas e Ícones.

Storyset

React-icons

---

Realizado como trablho no IFPB Campus Picuí. 💜

📝 Licença

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