/proffy

:school: Plataforma que conecta quem quer aprender com quem quer ensinar

Primary LanguageTypeScript

Proffy

GitHub release

Plataforma para conectar alunos e professores

Começando

As instruções a seguir irão lhe proporcionar uma cópia deste projeto e de como rodar em sua máquina local para propósito de desenvolvimento e testes. Veja na sessão de deployment para saber com mais detalhes de como dar deploy em sua aplicação.

Pre-requisitos

Dependências necessárias para se instalar o software e como instalá-las.

  1. Tenha certeza que você tenha o node instalado em sua máquina (https://nodejs.org/)
node -v
  1. E também o gerenciador de pacotes NPM (https://www.npmjs.com/)
npm -v

Instalação

Para rodar a aplicação, execute os próximos passos:

  1. Faça o clone do projeto
https://github.com/felipefariasdasilva/proffy.git
  1. Entre na pasta
cd proffy
  1. Instale as dependências
npm install
  1. Em seguida rode a aplicação
npm start
  1. Acesse no seu navegador o link de execução
http://localhost:3000

Finalize com um exemplo obtendo dados do sistema ou fazendo uma pequena demostração do funcionamento da aplicação

Executando os testes

1 . Execução dos testes unitáarios

npm test

Análise dos testes fim-a-fim

Explique o que esses testes testam e o porquê.

Dê um exemplo

Estilo de criação dos testes

Explique o que esses testes testam e o porque.

Dê um exemplo

🚀 Deployment

Adicione notas de como dar deploy do sistema em produção.

🔎 Desenvolvido com

  • ReactJS - O framework web utilizado

Contribuições

Criar um arquivo chamado CONTRIBUTING.md e colocar suas regras para contribuição nesse repositório.

Por favor leia CONTRIBUTING.md para mais detalhes a respeito do nosso código de contuda e o processo de submissão de pull-requests para nós.

Versionamento

Nós usamos [GitHub](https://github.com/ para versionamento. Para visualizar as versões disponíveis veja tags nesse repositórios.

Autores

Veja também a lista completa de contribuidores que contribuiram para o desenvolvimento deste projeto.

Licença

Esse projeto é licenciado pela MIT License - veja também LICENSE.md para mais detalhes

Agradecimentos

  • Inspiração
  • etc