👨‍🏫 Proffy 👩‍🏫

Sobre • Status • Funcionalidades • Como executar • Tecnologias • Autor • Licença

💻 Sobre o projeto

Proffy é uma plataforma que conecta professores e alunos para a realização de aulas privadas.

Projeto desenvolvido durante a NLW - Next Level Week #2 oferecida pela Rocketseat. A NLW é uma experiência online com muito conteúdo prático, desafios e hacks onde o conteúdo fica disponível durante uma semana.

---

📂 Sobre o repositório

Este repositório possui a API do projeto.

Acessar o repositório da aplicação web:
Acessar o repositório da aplicação mobile:

---

🏃‍♂️ Status

• v1
• v2 (🚧🚧 Em construção 🚧🚧)

---

⚙️ Funcionalidades

• Rotas da API
  • ./classes
    • POST: cadastra professor, aula e horários
    • GET: retorna professor, aula e horários, aplicando filtros por matéria, dia da semana e horário
  • ./connections
    • POST: incrementa contador de acessos
    • GET: retorna contador de acessos

---

🚀 Como executar o projeto

# Clone este repositório
$ git clone https://github.com/ErichComparin/Proffy_NLW2-API.git

# Acesse a pasta do projeto
$ cd Proffy-NLW2---nodeJS

# Instale as dependências
$ yarn install

# Inicie a API
$ yarn start

# A API será iniciada na porta 3333 - http://localhost:3333

---

🛠 Tecnologias

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

API (NodeJS + TypeScript)

• Express
  • Cors
• Knex
• Sqlite3

---

🧔 Autor

Erich Comparin

---

📝 Licença

Copyright © 2020 Erich Comparin.
This project is MIT licensed.

---

Versões do README

Português 🇧🇷