dbelarmino / proffy

Projeto desenvolvido durante a NLW - Next Level Week 2 oferecida pela @Rocketseat.

🚧 Proffy ♻️ Finalizado 🚀 🚧

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

💻 Sobre o projeto

♻️ Proffy - é uma plataforma de estudos onde conseguimos conectar alunos a professores para ter aulas online.

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 único objetivo é te levar para o próximo nível.

---

⚙️ Funcionalidades

• Professores podem se cadastrar na plataforma web enviando:

  • seus dados:
    • nome completo
    • link da sua foto
    • whatsapp
    • biografia
  • sobre a aula:
    • matéria
    • custo da sua hora por aula
  • horário disponíveis:
    • dia da semana
    • das - horário de incio
    • até - horário de fim

• navegar pela lista para ver os professores cadastradas

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

  • navegar pela lista para ver os professores cadastradas
  • favoritar os professores
  • entrar em contato com a entidade através do WhatsApp

---

🎨 Layout

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

Web

Mobile

---

🚀 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 + NPM, Yarn e 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 [e-mail]:douglasbelarmino/proffy.git proffy

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

# Vá para a pasta server
$ cd server

# Instale as dependências
$ yarn

# Execute as migrations no banco de dados
$ yarn knex:migrate

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

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

🧭 Rodando a aplicação web (Frontend)

# Clone este repositório
$ git clone [e-mail]:douglasbelarmino/proffy.git proffy

# 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
$ yarn

# Execute a aplicação
$ yarn start

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

🧭 Rodando o aplicativo (Mobile)

# Clone este repositório
$ git clone [e-mail]:douglasbelarmino/proffy.git proffy

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

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

# Instale as dependências
$ yarn

# Execute a aplicação
$ yarn start

---

🛠 Tecnologias

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

Web (React + TypeScript)

• React Router Dom
• 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
• Async Storage
• Axios

Veja o arquivo package.json

Utilitários

• Protótipo: Figma

• Editor: Visual Studio Code → Extensions: SQLite

• Markdown: Markdown Emoji

• Ícones: Ionicons, Feather Icons

• Fontes: Archivo, Poppins

---

👨‍💻 Contribuidores

Douglas Belarmino

💪 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

---

🦸 Autor

_{Douglas Belarmino}

---

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Douglas Belarmino 👋🏽 Entre em contato!

---