{"id":26948661,"url":"https://github.com/wynvern/cluster","last_synced_at":"2025-04-02T21:33:08.077Z","repository":{"id":263491044,"uuid":"792452033","full_name":"wynvern/cluster","owner":"wynvern","description":"Social media app for Projeto Tecnológico II and available for all the students present at Instituto Ivoti","archived":false,"fork":false,"pushed_at":"2024-11-25T18:45:55.000Z","size":55620,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-08T15:18:27.460Z","etag":null,"topics":["nodejs","postgresql","pwa-app","typescript"],"latest_commit_sha":null,"homepage":"https://cluster-it.vercel.app","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/wynvern.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}},"created_at":"2024-04-26T17:41:06.000Z","updated_at":"2024-11-25T18:45:59.000Z","dependencies_parsed_at":"2024-11-18T21:40:31.150Z","dependency_job_id":null,"html_url":"https://github.com/wynvern/cluster","commit_stats":null,"previous_names":["wynvern/cluster"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wynvern%2Fcluster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wynvern%2Fcluster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wynvern%2Fcluster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wynvern%2Fcluster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wynvern","download_url":"https://codeload.github.com/wynvern/cluster/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246896015,"owners_count":20851373,"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","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":["nodejs","postgresql","pwa-app","typescript"],"created_at":"2025-04-02T21:32:46.399Z","updated_at":"2025-04-02T21:33:08.072Z","avatar_url":"https://github.com/wynvern.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ✨ Projeto Cluster\n\nEste é um projeto [Next.js](https://nextjs.org/) inicializado com [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). O projeto consiste em uma aplicação similar a uma rede social que tem como objetivo juntar estudantes em grupos que poder ter diversas categorias.\n\n## 📝 Sobre o Projeto\n\nEste projeto é uma aplicação web desenvolvida com Next.js. Ele inclui várias funcionalidades:\n\n-   Renderização do lado do servidor\n-   Rotas dinâmicas\n-   Pré-renderização\n-   Suporte à PWA\n-   Banco de dados Postgres com Prisma ORM\n-   Utilização de service workers para notificações e caching\n-   Next-auth para entrada com serviços de terceiros\n-   Nodemailer para enviar emails\n-   Pacote sharp para otimizar as imagens e cortá-las (ocupando menos espaço)\n-   Socket.io para a comunicação de websockets em tempo real\n\nA aplicação utiliza Typescript como linguagem principal devido a tipagem, que faz o desenvolvimento ser mais seguro e direto ao ponto. Javascript também é utilizado para alguns serviços como conexão socket e encaminhamento de emails.\n\nOutras linguagens estrangeiras como Python também foram utilizadas para gerar conteúdos estáticos como as imagens para o PWA.\n\n## ⚙️ Como executar\n\nPrimeiro, instale as dependências do projeto:\n\n```bash\nnpm install\n# ou\nyarn\n```\n\nCarrege as migrações do Prisma no banco de dados:\n\n```bash\nnpx run prisma migrate dev\n# ou\nyarn prisma migrate dev\n```\n\nEm seguida, execute o servidor de desenvolvimento:\n\n```bash\nnpm run dev\n# ou\nyarn dev\n```\n\n**Nota:** Vale ressaltar que, como o projeto está rodando em um arquivo customizado `server.mjs`, não está pronto para rodar de forma serverless.\n\n**Nota:** Caso receba um erro do pacote sharp, rode `yarn add sharp --ignore-engines` o comando para instalar as dependências sem engine.\n\nPara manter o código pradonizado, instale o _biome_, usando as configurações já encontradas no arquivo `biome.json`. Evite utilizar ESLint ou Prettier. Deixe claro suas modificações no código ao realizar alguma commit.\n\n## Configuração do arquivo .env\n\nCrie um arquivo `.env` na raiz do projeto e preencha-o com suas variáveis de ambiente. Um exemplo do arquivo está em `.env.example`, onde estão as variáveis necessárias.\n\nCaso precise rodar o projeto em um codespaces, é necessário definir o hostname para o mesmo exposto pelo vscode, devido a um erro de origem.\n\n## 📁 Estrutura do Projeto\n\n-   `components/`: Esta pasta contém todos os componentes React usados na aplicação, separados em categorias e em formato _.tsx_.\n-   `styles/`: Aqui estão os arquivos de estilo globais e locais.\n-   `app/`: Esta pasta contém todas as rotas da aplicação. Cada arquivo corresponde a uma rota, a pasta `(pwp)/` guarda as rotas que contêm a navbar presente.\n-   `public/`: Esta pasta contém todos os arquivos estáticos como imagens e ícones.\n\n## 🛡️ Segurança\n\nTodos os formulários têm um honeypot para prevenir a criação de contas por spammers e bots. Ele é chamado de \"numberval\". São validados somente no servidor, logo as requisições continuam, porém sem interferir no banco de dados.\n\n## ☑️ To-Do\n\n-   [ ] Rotas do servidor dentro das pastas `lib/db` ainda precisam ser validadas por motivos de segurança;\n-   [ ] A autenticação do Socket.Io precisa ser melhorada;\n-   [ ] Blobs precisam ser removidos quando seus respectivos posts/usuários/grupos são deletados;\n-   [ ] Entre outros problemas menores de optimização e simplificação de código;\n\n## 👥 Autores\n\nEste projeto é mantido pelos seguinters indivíduos:\n\n-   **Wynvern** - Desenvolvedor - [GitHub](https://github.com/wynvern)\n-   **PietroSko** - Gerente do Projeto - [GitHub](https://github.com/pietrosko)\n-   **Gemellix2322** - Designer e Encarregado dos Documentos - [GitHub](https://github.com/gemellix2322)\n\nCada um contribuiu com suas habilidades e conhecimentos únicos para a criação e manutenção deste projeto.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwynvern%2Fcluster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwynvern%2Fcluster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwynvern%2Fcluster/lists"}