/TempLinkShare

A API TempLinkShare permite o compartilhamento seguro e temporário de arquivos. Faça upload de arquivos e obtenha links de download com tempo de expiração. Ideal para compartilhar arquivos sensíveis, garantindo acesso restrito e temporário.

Primary LanguageTypeScriptMIT LicenseMIT

TempLinkShare - API de Compartilhamento de Links Temporários

Minha imagem de exemplo

Sobre o projeto

O TempLinkShare é meu mais recente projeto pessoal, uma API que permite o compartilhamento seguro e temporário de arquivos. Suas principais funcionalidades incluem o upload de arquivos, a geração de links de download temporários e o compartilhamento de arquivos de maneira controlada, tudo com gerenciamento da validade dos links.

Tecnologias Utilizadas

My Skills

Como executar o projeto

⚠️ Para a execução do projeto, é necessário ter o Node.js instalado em sua máquina.

A porta padrão para acesso é http://localhost:3000

  1. Faça um clone do projeto
git clone https://github.com/maxsonferovante/TempLinkShare.git
  1. Abra o diretório do projeto
cd templinkshare
  1. Instale as dependências utilizando o comando:
npm install
  1. Inicialize o servidor local:
npm run dev
  1. Rodar os testes :
npm run test

Como executar o projeto - Docker Compose

docker compose up

Documentação - Swagger

Este projeto foi documentado utilizando o Swagger.

Para visualizar o Swagger no servidor utilize Swagger

Para acessar a documentação localmente, inicialize o projeto com npm run dev;

Abra http://localhost:3000/api-docs no navegador para visualizar localmente.

Deploy

Deploy

Como contribuir para o projeto

  1. Faça um fork do projeto.
  2. Crie uma nova branch com as suas alterações: git checkout -b my-feature
  3. Salve as alterações e crie uma mensagem de commit contanto o que você fez: git commit -m "feature: My new feature"
  4. Envie as alterações: git push origin my-feature

Autoras

Maxson Almeida

Licença

MIT