🚧 Proffy em construção 🚀 🚧

Sobre • Funcionalidades • Layout • Como executar • Tecnologias • Contribuidores • Autor • Licença

💻 Sobre o projeto

Proffy - é uma forma de conectar professores e mestres de diversas matérias escolares as pessoas que precisam reforçar seus estudos de maneira mais prática e fácil.

Projeto desenvolvido durante a NLW - Next Level Week 2 oferecida pela Rocketseat. O NLW é uma experiência online com muito conteúdo prático, desafios e hacks onde o conteúdo fica disponível durante uma semana.

---

⚙️ Funcionalidades

• Professores e mestres podem se cadastrar na plataforma web enviando:

  • uma imagem do seu avatar
  • nome completo e whatsapp
  • valor hora/aula para aparecer no card
  • além de selecionar uma ou mais matérias como:
    • Matemática
    • Português
    • História
    • Geografia
    • Artes
    • Ciências
    • Quimica
    • Física
    • Biologia
    • Inglês
    • entre outras

• Os usuários tem acesso ao aplicativo móvel, onde podem:

  • navegar pelo cards para ver os professores cadastradas
  • entrar em contato com o Proffy através do WhatsApp

---

🎨 Layout

O layout da aplicação está disponível no Figma:

Mobile

Web

---

🚀 Como executar o projeto

Este projeto é divido em três partes:

1. Backend (pasta server)
2. Frontend (pasta web)
3. Mobile (pasta mobile)

💡Tanto o Frontend quanto o Mobile precisam que o Backend esteja sendo executado para funcionar.

Pré-requisitos

Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Expo. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Backend (servidor)

# Clone este repositório
$ git clone git@github.com:wellingtoncid/Proffy.git

# Acesse a pasta do projeto no terminal/cmd
$ cd proffy

# Vá para a pasta server
$ cd server

# Instale as dependências
$ npm install ou yarn install

# Execute a aplicação em modo de desenvolvimento
$ npm run dev:server

# O servidor inciará na porta:3333 - acesse http://localhost:3333 

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone git@github.com:wellingtoncid/Proffy.git

# Acesse a pasta do projeto no seu terminal/cmd
$ cd proffy

# Vá para a pasta da aplicação Front End
$ cd web

# Instale as dependências
$ npm install ou yarn install

# Execute a aplicação em modo de desenvolvimento
$ npm run start ou yarn start

# A aplicação será aberta na porta:3000 - acesse http://localhost:3000

---

🛠 Tecnologias

As seguintes ferramentas foram usadas na construção do projeto:

Website (React + TypeScript)

• React Router Dom
• React Icons
• Axios

Veja o arquivo package.json

Server (NodeJS + TypeScript)

• Express
• CORS
• KnexJS
• SQLite
• ts-node

Veja o arquivo package.json

Mobile (React Native + TypeScript)

• Expo
• Expo Google Fonts
• React Navigation

• Expo Constants
• React Native SVG
• Axios

Veja o arquivo package.json

Utilitários

• Protótipo: Figma → Protótipo (Proffy)

• Editor: Visual Studio Code → Extensions: SQLite
• Markdown: StackEdit, Markdown Emoji

• Teste de API: Insomnia
• Ícones: Feather Icons, Font Awesome
• Fontes: Archivo, Poppins

---

👨‍💻 Contribuidores

💜 Um super thanks 👏 para a galera da Rocketseat que fez esse produto sair do campo da ideia e futuramente vai entrar nas lojas de aplicativos :)

Wellington Cid 👨‍🚀

💪 Como contribuir para o projeto

1. Faça um fork do projeto.
2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
3. Salve as alterações e crie uma mensagem de commit contando o que você fez: git commit -m "feature: My new feature"
4. Envie as suas alterações: git push origin my-feature

Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

---

🦸 Autor

_{Wellington Cid} 🚀

---

📝 Licença

Este projeto esta sob a licença MIT.

Feito com ❤️ por Wellington Cid 👋🏽 Entre em contato!

---