API de Gamificação

Esta API é um projeto de código aberto que implementa conceitos de gamificação para incentivar a produção de texto em dois blogs do tipo Wiki através de uma API Restful. Desenvolvido em Node.js utilizando Express.js e banco de dados MySQL. Este repositório é apenas a API Restful. A API pode ser utilizada para qualquer blog que tenha as características de Wiki.

---

Requisitos de sistema (Mac OS, Windows or Linux)

• Docker
• Docker Compose
• Node.js

Como desenvolver?

Copiar variáveis de ambiente:

cp .env.example .env

Instalar dependências:

npm install

Subir servidor MySQL e phpmyadmin:

docker-compose up --build

Rodar aplicação web:

npm start

---

Documentação

• API

Informações gerais

• Todos os endpoints retornam o formato application/json
• Todas requisições devem conter o header Accept : application/json
• Todas requisições POST e PUT devem conter o header Content-Type : application/json
• A aplicação usa a biblioteca Express.js para a base da construção da API