gabrielpatrola / proffy

Conectando alunos e professores de maneira inteligente e rápida!

📚 Aplicação Proffy v1.0

Node.js | ReactJS | React Native

Sobre · Tecnologias utilizadas · Como usar · To Do · Como contribuir · Licença

💭 Sobre

Proffy é uma aplicação que tem como objetivo conectar estudantes e professores, dentro dela é fornecido um espaço para que professores registrem sua disponibilidade de horários durante a semana, matérias que leciona, telefone para contato (WhatsApp) e também o custo de sua hora/aula. Já para o estudante é possível encontrar tutores entrar em contato com eles via WhatsApp e também salvar "proffys" em seus favoritos.

A aplicação foi desenvolvida durante a segunda edição da Next Level Week da RocketSeat, entre os dia 03/08/2020 e 09/08/2020, por conta disso foi feita essa homenagem ao dia Nacional dos Profissionais da Educação, que é comemorado em 06 de agosto.

👨‍💻 Tecnologias Utilizadas

• React no frontend web;
• React Native com Expo no frontend mobile;
• Node com Express no backend;
• TypeScript para tipagem do projeto como um todo.

⁉ Como usar

🤔 Pré-requisitos

Para conseguir utilizar a aplicação sem nenhum problema é necessário ter:

• O Node.js instalado no computador para a execução do backend
• Ter em sua máquina o NPM ou Yarn para o gerenciamento dos pacotes da aplicação
• Expo instalado de forma global na máquina para a execução da aplicação mobile
• E não menos importante, o Git para clonar o repositório em seu computador

📝 Passo a passo

Primeiro clone o repositório em seu computador, por meio do terminal utilizando o comando:

1. Clonando o repositório

  # Clone o repositório
  $ git clone https://github.com/Gabrielpatrola/proffy.git
  # Entre na pasta raiz da aplicação
  $ cd proffy

2. Iniciando o Backend

  # Entre na pasta do backend
  $ cd server
  # Instale as dependências da aplicação
  $ yarn # ou npm install
  # Crie o banco de dados da aplicação
  $ yarn knex:migrate # ou npm run knex:migrate
  # Inicie o servidor
  $ yarn start # ou npm start

3. Iniciando o Frontend web

  # Entre na pasta da aplicação web
  $ cd web
  # Instale as dependências da aplicação
  $ yarn # ou npm install
  # Inicie a aplicação web
  $ yarn start # ou npm start

4. Iniciando a aplicação Mobile

  # Entre na pasta da aplicação mobile
  $ cd mobile
  # Instale as dependências da aplicação
  $ yarn # ou npm install
  # Inicie a aplicação mobile
  $ yarn start # ou npm start

❗ To Do

Esse projeto não terminou ainda, na versão 2.0 será implementado novas funcionalidades para a aplicação como um todo para tornar ela ainda melhor são elas:

• Criação das telas seguindo o layout do Figma
• Possibilidade de Autenticação e registro de usuários
• Funcionalidade de recuperação de senhas
• Criação do perfil de usuário
• Splash Screen na aplicação mobile
• Paginação na listagem de proffys
• Exibição horários disponíveis dos proffys
• Possibilidade de salvar seus proffys favoritos
• Logout da aplicação
• Deploy da aplicação

Fique atento para as atualizações desse projeto. Não esqueça de deixar uma estrela nesse repositório!

💪 Como contribuir

Basta criar um fork do projeto, realizar as modificações que achar necessário e depois fazer um Pull Request. Toda ajuda é bem vinda, caso veja algum erro, não hesite em contribuir com o projeto!

📃 Licença

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

---

^{Feito com 💙 por Gabriel Patrola por meio da tutoria do Diego Fernandes, da Rocketseat.}