Forum API Server

API de aplicação de fórum, estilo Reddit, utilizada para apoiar o ensino de desenvolvimento web com ReactJS

Instalação e Execução

Aplicação desenvolvida com Node.js v20.x.x

Para instalar as dependências do projeto

npm install

Para compilar e executar a aplicação

npm run build && npm run start

Para executar a aplicação no modo "desenvolvedor"

npm run dev

Para executar a aplicação em ambiente produtivo:

npm run build && npm run start:production

O servidor é executado na porta 5000, se disponível.

Uso

Documentação

Documentação da API disponível em http://localhost:5000/api-docs.

Autenticação

Para consumir a API, se faz necessário a definição de um Header Authorization nos requests, contendo a senha informada no arquivo .env. O intuito é simular uma autenticação real.

Crie um arquivo .env na raiz do projeto, contendo a chave abaixo associada com o valor que desejar usar para exigir autenticação:

AUTH_KEY=