8000 GitHub - pedroksty/Proffy: A new platform to connect teachers and students in an efficient way.
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

pedroksty/Proffy

Repository files navigation

proffy

GitHub language count Repository size Siga no Twitter GitHub last commit License Stargazers

💻 Sobre o projeto

Proffy - é uma plataforma de conectar alunos e professores de maneira fácil.

🎨 Layout

📱 Mobile

proffy proffy proffy

🧭 Web

proffy proffy

🛠 Tecnologias

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

🚀 Como executar o projeto

Podemos considerar este projeto como sendo divido em três partes:

  1. Back End (pasta packages/server)
  2. Front End (pasta packages/web)
  3. Mobile (pasta packages/mobile)

💡Tanto o Front End quanto o Mobile precisam que o Back End 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, Yarn. Além disto é bom ter um editor para trabalhar com o código como VSCode

🎲 Rodando o Back End (servidor)

# 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

🧭 Rodando a aplicação web (Front End)

# 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

📱Rodando a aplicação mobile

# 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

😯 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

    Caso tenha alguma dúvida confira este guia de como contribuir no GitHub

📝 Licença

Este projeto esta sobe a licença MIT.

Feito com ❤️ por Pedro henrique 👋🏽 Entre em contato!

About

A new platform to connect teachers and students in an efficient way.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published
0