Proffy

NLW#2 - Next Level Week - By Rocketseat

Stars
17
Committers
1

Sobre o projeto

Uma plataforma de estudos online que visa conectar alunos e professores de forma rpida e fcil.

O projeto est sendo desenvolvido na Next Level Week 2

Screenshots

Techs

Proffy foi construdo com as seguintes techs:

Instalao e Start

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

Instalao

Clone o repositrio:

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

Start

Entre no repositrio clonado e em seu diretrio correspondente ao projeto web (somente interface web no momento):

cd ./proffy/web

Instale as dependncias e starte

NPM
# Instala todas as dependncias
> npm install 

# Starta o servidor web para a plataforma Proffy
> npm start 
YARN
# Instala todas as dependncias
> yarn install 

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

Contribuies

Siga os passos abaixo para contribuir:

  1. Faa o fork do projeto (https://github.com/Vinidevsantos/Proffy)

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

  3. Crie uma branch para realizar sua modificao (git checkout -b feature/name_new_feature)

  4. Adicione suas modificaes e faa o commit (git commit -m "Descreva sua modificao")

  5. Push (git push origin feature/name_new_feature)

  6. Crie um novo Pull Request

  7. Pronto, agora s aguardar a anlise

License

O projeto est sobre a licena MIT

Gostou? Deixe uma estrelinha para ajudar o projeto

Feito com por Vinicius Santos Entre em contato!