CatBoard API é uma API para compartilhar imagens, feita seguindo os padrão MVC. A API permite que os usuários enviem, visualizem e pesquisem imagens semelhantes utilizando tags que descrevem as caracteristicas das imagens.
Para instalar a API, siga os seguintes passos:
- Clone o repositório:
git clone https://github.com/purumamerin/catboard-api.git - Navegue até a pasta do projeto:
cd catboard-api - Instale as dependências:
npm install - Inicie o servidor:
npm start - Crie um arquivo de configuração:
module.exports = {
connectionString: "",
TOKEN_SECRET: "",
sendgridKey: "",
containnerAccount: "",
containnerAccountKey: ""
}O servidor será iniciado na porta 3000 por padrão. Você pode alterar a porta de escuta editando a variável de ambiente PORT.
A API possui autenticação utilizando JsonWebToken.
A API foi construída utilizando as seguintes tecnologias:
- Node.js
- Express.js
- MongoDB & Mongoose
- JsonWebToken
- Azure blob storage
Se você deseja contribuir para o projeto, por favor, abra um pull request com suas alterações.
Este projeto é licenciado sob a licença MIT. Consulte o arquivo LICENSE para obter mais informações.