https://github.com/maxsonferovante/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.
https://github.com/maxsonferovante/templinkshare
api docker-compose jwt-authentication nodejs postgresql s3-bucket typescript
Last synced: 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/maxsonferovante/templinkshare
- Owner: maxsonferovante
- License: mit
- Created: 2023-10-27T23:39:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-02T03:36:44.000Z (about 1 year ago)
- Last Synced: 2025-01-30T09:17:02.913Z (4 months ago)
- Topics: api, docker-compose, jwt-authentication, nodejs, postgresql, s3-bucket, typescript
- Language: TypeScript
- Homepage:
- Size: 19.7 MB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
TempLinkShare - API de Compartilhamento de Links Temporários
## 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
[](https://skillicons.dev)
## Como executar o projeto
⚠️ Para a execução do projeto, é necessário ter o [Node.js](https://nodejs.org/en) instalado em sua máquina.
A porta padrão para acesso é ` http://localhost:3000 `
1) Faça um clone do projeto
```bash
git clone https://github.com/maxsonferovante/TempLinkShare.git
```
2) Abra o diretório do projeto
```bash
cd templinkshare
```
3) Instale as dependências utilizando o comando:
```bash
npm install
```
4) Inicialize o servidor local:
```bash
npm run dev
```
5) Rodar os testes :
```bash
npm run test
```
## Como executar o projeto - Docker Compose
```bash
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](https://github.com/maxsonferovante)
## Licença
[MIT](LICENSE)