Skip to content

🚀 Project made to connect teachers to students

License

Notifications You must be signed in to change notification settings

jose-bone/proffy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

75 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Proffy

Tecnologias   |    Projeto   |    Layout   |    Funcionalidades   |    Como rodar   |    Licença

PRs welcome! License


Proffy

Mobile Screenshot

🚀 Tecnologias

Esse projeto foi desenvolvido com as seguintes tecnologias:

💻 Projeto

O Proffy é uma plataforma de estudos online que ajuda pessoas a encontrarem professores online.

🔖 Layout

Nos links abaixo você encontra o layout do projeto web e também do mobile. Lembrando que você precisa ter uma conta no Figma para acessá-lo.

🚀 Funcionalidades

  • Site para cadastro de estudante e professores.
  • App para conectar estudantes e professores.

👷 Como rodar

# Clone o Repositório
$ git clone https://github.com/jose-bone/proffy.git

📦 Rode a API

# Vá para a pasta do servidor
$ cd proffy/server

# Instale as dependências
$ yarn install

# Rode a aplicação
$ yarn start

Acesse a API: http://localhost:3333/

💻 Rode o Project Web

# Vá para a pasta web
$ cd proffy/web

# Instale as dependências
$ yarn install

# Rode a aplicação
$ yarn start

Acesse: http://localhost:3000/ para ver o resultado.

📱 Run Mobile Project

Para rodar o projeto mobile você precisa de um celular com o expo instalado ou um emulador android/ios.

# Vá para a pasta mobile
$ cd proffy/mobile

# Instale as dependências
$ yarn install

# Rode a aplicação
$ yarn start

Depois leia o QRCode com o app do expo ou rode em um emulador.

🐛 Problemas

Fique a vontade para criar uma nova issue com o respetivo titulo e descrição na página de issues do Proffy Repositório. Se você já encontrou a solução para o problema, Eu amaria fazer o review do seu pull request!

♻ Como contribuir

  • Faça fork deste repositório,
  • Crie uma branch com a sua feature: git checkout -b my-feature
  • Commit suas mudanças: git commit -m 'feat: My new feature'
  • Push a sua branch: git push origin my-feature

📝 Licença

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


Feito com 💜 by José Boné 👋