🚧 Em construção da próxima versão 🚧
Sobre • Funcionalidades • Layout • Como executar • Tecnologias • Autor • Licença
💻 Sobre o projeto
Projeto desenvolvido com intuito de prover a conexão entre professores e alunos.
Projeto desenvolvido durante a NLW - Next Level Week 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
- Cadastro de Professores
- Conexão Aluno - Professor
- Entrar em contato via Whatsapp
- Login
- Aulas ao vivo
Layout
🚀 Como executar o projeto
Este projeto é divido em três partes:
- Proffy-api (pasta server)
- Proffy-web (pasta web)
- Proffy-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. Além disto é bom ter um editor para trabalhar com o código como VSCode
🧭 Rodando a aplicação web (Frontend)
# Clone este repositório
$ git clone git@github.com:VictorhMalheiro/proffy-web.git
# Acesse a pasta do projeto no seu terminal/cmd
$ cd proffy-web
# Instale as dependências
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ yarn start
# A aplicação será aberta na porta:3000 - acesse http://localhost:3000
🎲 Rodando o Backend (servidor)
# Clone este repositório
$ git clone git@github.com:VictorhMalheiro/proffy-api.git
# Acesse a pasta do projeto no terminal/cmd
$ cd proffy-api
# Instale as dependências
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ yarn start
# O servidor inciará na porta:3333 - acesse http://localhost:3333
🛠 Tecnologias
As seguintes ferramentas foram usadas na construção do projeto:
Website (React + TypeScript)
Veja o arquivo package.json
💪 Como contribuir para o projeto
- Faça um fork do projeto.
- Crie uma nova branch com as suas alterações:
git checkout -b my-feature - Salve as alterações e crie uma mensagem de commit contando o que você fez:
git commit -m "feature: My new feature" - Envie as suas alterações:
git push origin my-feature
🦸 Autor
Victor Malheiro 🚀
📝 Licença
Este projeto esta sobe a licença MIT.
Feito com ❤️ por Victor Malheiro 👋🏽 Entre em contato!