Proffy - é uma plataforma de conectar alunos e professores de maneira fácil.
As seguintes ferramentas foram usadas na construção do projeto:
Podemos considerar este projeto como sendo divido em três partes:
- Back End (pasta packages/server)
- Front End (pasta packages/web)
- Mobile (pasta packages/mobile)
💡Tanto o Front End quanto o Mobile precisam que o Back End esteja sendo executado para funcionar.
Antes de começar, você vai precisar ter instalado em sua máquina as seguintes ferramentas: Git, Node.js, Yarn. Além disto é bom ter um editor para trabalhar com o código como VSCode
# Clone este repositório
$ git clone https://github.com/pedroksty/proffy.git
# Acesse a pasta do projeto no terminal/cmd
$ cd proffy
# Vá para a pasta server
$ cd packages/server
# Instale as dependências
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ yarn dev
# O servidor inciará na porta:4444 - acesse http://localhost:4444
# Clone este repositório
$ git clone https://github.com/pedroksty/proffy.git
# Acesse a pasta do projeto no seu terminal/cmd
$ cd proffy
# Vá para a pasta da aplicação Front End
$ cd packages/web
# Instale as dependências
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ yarn dev
# A aplicação será aberta na porta:3000 - acesse http://localhost:3000
# Clone este repositório
$ git clone https://github.com/pedroksty/proffy.git
# Acesse a pasta do projeto no seu terminal/cmd
$ cd proffy
# Vá para a pasta da aplicação Front End
$ cd packages/mobile
# Instale as dependências
$ yarn
# Execute a aplicação em modo de desenvolvimento
$ yarn start
# Escanei o QR CODE com o aplicativo Expo instalado no seu Smarthphone
- 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
Caso tenha alguma dúvida confira este guia de como contribuir no GitHub
Este projeto esta sobe a licença MIT.
Feito com ❤️ por Pedro henrique 👋🏽 Entre em contato!