📌 Index
❔ Sobre o projeto
Uma plataforma de estudos online que visa conectar alunos e professores de forma rápida e fácil.
O projeto está sendo desenvolvido na Next Level Week 2
📸 Screenshots
Interface Web para Desktop
Interface Web para Mobile
🛠 Techs
Proffy foi construído com as seguintes techs:
⚙ Instalação e Start
Certifique-se de que tenha o Node.js e um gerenciador de dependências em seu ambiente antes de seguir os passos abaixo.
Para instalar e startar a plataforma Proffy, use npm ou yarn:
Clonagem
Primeiro, clone o repositório para seu ambiente:
> git clone https://github.com/matheusfelipeog/proffy.git Depois, entre no repositório clonado e no diretório correspondente ao que quer testar (web, server). Logo após, insira os seguintes comandos no seu terminal para cada diretório respectivamente:
Web
# Entra no diretório "web"
> cd ./proffy/web
# Instala todas as dependências
> yarn install
# Starta o servidor web para a plataforma Proffy
> yarn start Será startado em http://localhost:3000
Server
# Entra no diretório "server"
> cd ./proffy/server
# Instala todas as dependências
> yarn install
# Starta o servidor web para a plataforma Proffy
> yarn start Será startado em http://localhost:5000
🤝 Contribuições
Siga os passos abaixo para contribuir:
-
Faça o fork do projeto (https://github.com/matheusfelipeog/proffy)
-
Clone o seu fork para sua maquína (
git clone https://github.com/user_name/proffy.git) -
Crie uma branch para realizar sua modificação (
git checkout -b feature/name_new_feature) -
Adicione suas modificações e faça o commit (
git commit -m "Descreva sua modificação") -
Push (
git push origin feature/name_new_feature) -
Crie um novo Pull Request
-
Pronto, agora só aguardar a análise
🚀
📜 License
O projeto está sobre a licença MIT
Gostou? Deixe uma estrelinha para ajudar o projeto