{"id":29861333,"url":"https://github.com/danilo-fq/brevly","last_synced_at":"2026-04-03T23:36:55.337Z","repository":{"id":298312568,"uuid":"999530484","full_name":"danilo-fq/brevly","owner":"danilo-fq","description":"Brev.ly é uma aplicação moderna de encurtamento de URLs, com exportação de relatórios, testes automatizados e uma arquitetura full-stack utilizando Node.js, React, PostgreSQL e Cloudflare R2.","archived":false,"fork":false,"pushed_at":"2025-07-21T13:26:14.000Z","size":244,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-21T15:29:11.499Z","etag":null,"topics":["api-rest","cloudflare-r2","docker","docker-compose","drizzle-orm","fastify","fullstack","nodejs","pnpm","postgresql","react","relatorios-csv","tailwindcss","testes-integracao","typescript","url-shortener","vite","vitest"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/danilo-fq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-10T11:47:21.000Z","updated_at":"2025-07-21T13:45:29.000Z","dependencies_parsed_at":"2025-07-08T16:51:10.642Z","dependency_job_id":null,"html_url":"https://github.com/danilo-fq/brevly","commit_stats":null,"previous_names":["danilo-fq/brevly"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/danilo-fq/brevly","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danilo-fq%2Fbrevly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danilo-fq%2Fbrevly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danilo-fq%2Fbrevly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danilo-fq%2Fbrevly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/danilo-fq","download_url":"https://codeload.github.com/danilo-fq/brevly/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/danilo-fq%2Fbrevly/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267814181,"owners_count":24148326,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-30T02:00:09.044Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-rest","cloudflare-r2","docker","docker-compose","drizzle-orm","fastify","fullstack","nodejs","pnpm","postgresql","react","relatorios-csv","tailwindcss","testes-integracao","typescript","url-shortener","vite","vitest"],"created_at":"2025-07-30T05:01:12.416Z","updated_at":"2025-12-30T19:54:19.828Z","avatar_url":"https://github.com/danilo-fq.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Brev.ly\n\nBrev.ly é um encurtador de URLs simples e eficiente, projetado para transformar links longos em URLs curtas e fáceis de compartilhar.\n\n\u003e **Aviso:** Este projeto está em desenvolvimento. Novas funcionalidades e melhorias serão adicionadas em breve.\n\n---\n\n## 🚀 Tecnologias Utilizadas\n\n- **Node.js** (backend)\n- **TypeScript**\n- **Fastify** (API HTTP)\n- **Drizzle ORM** (migrations e acesso ao banco)\n- **PostgreSQL** (banco de dados)\n- **React** + **Vite** (frontend)\n- **TailwindCSS** (estilização)\n- **Cloudflare R2** (armazenamento de arquivos)\n- **Vitest** (testes)\n- **Docker** \u0026 **Docker Compose** (containerização)\n- **pnpm** (gerenciador de pacotes)\n\n---\n\n## 📁 Estrutura do Projeto\n\n```\nbrevly/\n├── server/         # Backend (API, banco, migrations)\n│   ├── src/\n│   ├── dist/\n│   ├── Dockerfile\n│   ├── compose.yaml\n│   └── .env\n├── web/            # Frontend (React)\n│   ├── src/\n│   ├── public/\n│   └── vite.config.ts\n└── README.md\n```\n\n---\n\n## ⚙️ Pré-requisitos\n\n- [Node.js](https://nodejs.org/) 20+\n- [pnpm](https://pnpm.io/) 8+\n- [Docker](https://www.docker.com/) e [Docker Compose](https://docs.docker.com/compose/)\n- (Opcional) Conta Cloudflare R2 para armazenamento\n\n---\n\n## 🛠️ Principais Comandos\n\n### Backend (server)\n\n| Comando                  | Descrição                                      |\n|--------------------------|------------------------------------------------|\n| `pnpm install`           | Instala as dependências                        |\n| `pnpm dev`               | Inicia o servidor em modo desenvolvimento      |\n| `pnpm build`             | Gera o build de produção                       |\n| `pnpm start`             | Inicia o servidor em produção                  |\n| `pnpm db:generate`       | Gera as migrations com Drizzle ORM             |\n| `pnpm db:migrate`        | Aplica as migrations no banco de dados         |\n| `pnpm test`              | Executa os testes unitários                    |\n\n### Frontend (web)\n\n| Comando                  | Descrição                                      |\n|--------------------------|------------------------------------------------|\n| `pnpm install`           | Instala as dependências                        |\n| `pnpm dev`               | Inicia o frontend em modo desenvolvimento      |\n| `pnpm build`             | Gera o build de produção                       |\n| `pnpm preview`           | Visualiza o build de produção localmente       |\n\n---\n\n## 🐳 Como rodar com Docker\n\n1. **Clone o repositório e acesse a pasta do projeto:**\n   ```sh\n   git clone https://github.com/danilo-fq/brevly.git\n\n   cd brevly/server\n\n   pnpm install\n   ```\n\n2. **Configure as variáveis de ambiente:**\n   - Copie o arquivo `.env.example` para `.env` e ajuste conforme necessário.\n\n3. **Suba os containers do backend e banco de dados:**\n   ```sh\n   docker compose up -d\n   ```\n\n4. **Aplique as migrations para criar as tabelas no banco:**\n   ```sh\n   pnpm db:migrate\n   ```\n\n5. **(Opcional) Suba o frontend:**\n   ```sh\n   cd ../web\n   pnpm install\n   pnpm dev\n   ```\n\n---\n\n## 📝 Fluxo de Deploy/Execução\n\n1. **Instale as dependências** do backend e frontend.\n2. **Configure o arquivo `.env`** com as variáveis do banco, Cloudflare, etc.\n3. **Suba os containers** com Docker Compose.\n4. **Rode as migrations** para criar as tabelas no banco.\n5. **Acesse a API** em `http://localhost:3333` e o frontend em `http://localhost:5173` (ou porta configurada).\n\n---\n\n## 🧪 Testes\n\nPara rodar os testes do backend, entre na pasta server e rode o comando:\n```sh\npnpm test\n```\n\n---\n\n## ☁️ Integração com Cloudflare R2\n\nO projeto suporta exportação de relatórios CSV para o Cloudflare R2. Configure as variáveis de ambiente relacionadas no `.env` para ativar essa funcionalidade. Caso não faça uma configuração do Cloudflare R2 não será possível baixar o relatório CSV.\n\n---\n\n## 💡 Observações\n\n- As migrations **devem ser aplicadas manualmente** após subir os containers, usando `pnpm db:migrate`.\n- O projeto utiliza Drizzle ORM para versionamento e aplicação das migrations.\n- O frontend e backend são independentes, mas podem ser rodados juntos via Docker Compose.\n\n---\n\n## 👨‍💻 Autor\n\n- [Danilo](https://github.com/danilo-fq)\n\n---\n\nSinta-se à vontade para contribuir, abrir issues ou sugerir melhorias. Obrigado por usar o Brev.ly!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanilo-fq%2Fbrevly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdanilo-fq%2Fbrevly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdanilo-fq%2Fbrevly/lists"}