📌 Index

• Sobre o projeto
• Screenshots
• Techs
• Instalação e Start
  • Clonagem
  • Web
  • Server
• Contribuições
• License

❔ 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:

• Web
  • React
  • Typescript
• Server
  • Node.js
  • Express
  • Knex
• Banco de Dados
  • Sqlite3

⚙ 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:

1. Faça o fork do projeto (https://github.com/matheusfelipeog/proffy)

2. Clone o seu fork para sua maquína (git clone https://github.com/user_name/proffy.git)

3. Crie uma branch para realizar sua modificação (git checkout -b feature/name_new_feature)

4. Adicione suas modificações e faça o commit (git commit -m "Descreva sua modificação")

5. Push (git push origin feature/name_new_feature)

6. Crie um novo Pull Request

7. Pronto, agora só aguardar a análise 🚀

📜 License

O projeto está sobre a licença MIT ❤️

Gostou? Deixe uma estrelinha para ajudar o projeto ⭐