README.md

❔ 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

🛠 Techs

Proffy foi construído com as seguintes techs:

• React
• Typescript
• Node.js

⚙ Instalação e Start

Para instalar e startar a plataforma Proffy em seu ambiente, siga os passos abaixo:

Instalação

Clone o repositório:

git clone https://github.com/vinidevsantos/proffy.git 

Start

Entre no repositório clonado e em seu diretório correspondente ao projeto web (somente interface web no momento):

cd ./proffy/web

Instale as dependências e starte 🚀

NPM

# Instala todas as dependências
> npm install 

# Starta o servidor web para a plataforma Proffy
> npm start 

YARN

# Instala todas as dependências
> yarn install 

# Starta o servidor web para a plataforma Proffy
> yarn start 

🤝 Contribuições

Siga os passos abaixo para contribuir:

1. Faça o fork do projeto (https://github.com/Vinidevsantos/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 ⭐

Feito com ❤️ por Vinicius Santos 👋🏽 Entre em contato!