README-pt.md

Inglês · Português

Sobre   |    Upgrades   |    Tecnologias   |    Ferramentas   |    Instalação   |    Telas   |    Licença

🔖 Sobre

O BeTheHero tem por objetivo aproximar entidades necessitadas á usuários dispostos a ajudá-las. O backend consiste em uma API Rest rodando em um servidor NodeJS. O frontend foi feito com React e o app mobile com React Native. Este projeto foi implementado durante a Semana Omni Stack #11 da Rocketseat.

⬆️ Upgrades

As seguintes alterações foram feitas após a finalização do projeto da RocketSeat:

• Exibição de um spinner nos botões de requisição e carregamento dos casos.
• Migração de CSS modules para Styled-components.
• Adição de uma confirmação para exclusão de casos.
• Aplicação de uma máscara no campo whatsapp do cadastro de Ongs.
• Utilização da API do IBGE para preenchimento dos campos uf e cidade no cadastro de Ongs.
• Envio de e-mail para confirmação do cadastro de Ongs.
• Recuperação de senha.
• Autenticação por e-mail e senha.
• Criação de um favicon.

💻 Tecnologias

• Javascript
• Node.js
• Express
• Knex
• SQLite
• ReactJS
• React Native
• Celebrate
• Expo
• Axios
• Jest
• NodeMailer
• JWT
• Styled-Components

🔧 Ferramentas

• VisualStudio Code
• Insomnia
• Google Chrome
• DBeaver

📦 Instalação

✔️ Pré-requisitos

Os seguintes softwares devem estar instalados:

• Node.js
• Git
• NPM
• Expo
• Expo App

⬇️ Clonando o repositório

  $ git clone https://github.com/maiquelp/beTheHero.git

▶️ Rodando as aplicações

• 📦 API

  $ cd backend
  # Dependencies install.
  $ npm install
  # Data base creation.
  $ npm run knex:migrate
  # API start
  $ npm run dev

• 💻 Web app

  $ cd frontend
  # Dependencies install.
  $ npm install
  # Running web app
  $ npm run dev

• 📱 Mobile app

  $ cd mobile
  # Dependencies install.
  $ npm install
  # Running mobile app
  $ npm start

📸 Telas

• Frontend

• Mobile

📝 Licença

Este projeto está sob uma licença MIT.