{"id":18778466,"url":"https://github.com/will-santosx/quick-notes","last_synced_at":"2026-04-16T14:06:32.406Z","repository":{"id":248793781,"uuid":"829789535","full_name":"will-santosx/quick-notes","owner":"will-santosx","description":"Um aplicativo web para criar e gerenciar anotações rápidas e breves.","archived":false,"fork":false,"pushed_at":"2024-11-29T12:50:59.000Z","size":154,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-21T05:36:27.970Z","etag":null,"topics":["frontend","nextjs","notes-app","react","tiptap","typescript","webapp"],"latest_commit_sha":null,"homepage":"https://quick-notes-drab.vercel.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/will-santosx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2024-07-17T02:52:53.000Z","updated_at":"2024-07-28T02:44:40.000Z","dependencies_parsed_at":"2025-05-21T05:41:09.764Z","dependency_job_id":null,"html_url":"https://github.com/will-santosx/quick-notes","commit_stats":null,"previous_names":["will-santosx/quick-notes"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/will-santosx/quick-notes","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/will-santosx%2Fquick-notes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/will-santosx%2Fquick-notes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/will-santosx%2Fquick-notes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/will-santosx%2Fquick-notes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/will-santosx","download_url":"https://codeload.github.com/will-santosx/quick-notes/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/will-santosx%2Fquick-notes/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":259606977,"owners_count":22883559,"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":["frontend","nextjs","notes-app","react","tiptap","typescript","webapp"],"created_at":"2024-11-07T20:16:21.813Z","updated_at":"2026-04-16T14:06:32.320Z","avatar_url":"https://github.com/will-santosx.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\n\n# Quick Notes Documentation\n\n## Overview\n\nQuick Notes é um aplicativo web para criar e gerenciar anotações rápidas e breves. Foi desenvolvido usando Next.js e a biblioteca Tiptap para edição de rich text. A aplicação oferece funcionalidades de criação, visualização e remoção de anotações.\n\n## Features\n\n- **Criação de anotações:** Permite ao usuário criar novas anotações.\n- **Visualização de anotações:** Exibe as anotações existentes com formatação rich text.\n- **Remoção de anotações:** Permite ao usuário remover anotações existentes.\n\n## Instalação\n\n### Requisitos\n\nCertifique-se de ter o Node.js instalado na sua máquina. Recomenda-se usar a versão LTS.\n\n### Steps\n\n1. **Clone o repositório:**\n\n   ```bash\n   git clone https://github.com/will-santosx/quick-notes\n   cd quick-notes\n   ```\n\n2. **Instale as dependências:**\n\n   ```bash\n   npm install\n   ```\n\n3. **Execute a aplicação:**\n\n   ```bash\n   npm run dev\n   ```\n\n   A aplicação estará disponível em [http://localhost:3000](http://localhost:3000).\n\n### Arquivos Importantes\n\n- **src/app/components/ui/**: Contém componentes de interface do usuário reutilizáveis, como `AppLoading` e `Button`.\n- **src/app/page.tsx**: Componente principal da página de anotações, responsável por exibir, carregar e remover anotações.\n- **src/utils/axiosService.ts**: Configuração do Axios para facilitar as requisições HTTP.\n- **src/anotacao/nova/page.tsx**: Componente principal da página de novas anotações, responsável por criar anotações.\n\n## Usage\n\n### Visualizando uma anotação\n\nNa página de visualização de anotações (`page.tsx`), o conteúdo da anotação é carregado a partir do servidor e exibido usando o editor Tiptap. A data de criação é formatada usando `date-fns`.\n\n### Removendo uma anotação\n\nA função `removeNote` faz uma requisição DELETE para o servidor, removendo a anotação especificada. Após a remoção, o usuário é redirecionado para a página inicial.\n\n## Contributing\n\n1. Fork este repositório.\n2. Crie uma nova branch (`git checkout -b feature/nova-feature`).\n3. Faça suas alterações e commite (`git commit -m 'Adicionei nova feature'`).\n4. Faça o push para a branch (`git push origin feature/nova-feature`).\n5. Abra um Pull Request.\n\n## License\n\nEste projeto é licenciado sob a licença MIT. Veja o arquivo LICENSE para mais detalhes.\n\n---\n\nEsta documentação serve como um guia básico para desenvolvedores que desejam entender, instalar e contribuir para o projeto Quick Notes. Sinta-se à vontade para expandi-la conforme o projeto cresce e novas funcionalidades são adicionadas.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwill-santosx%2Fquick-notes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwill-santosx%2Fquick-notes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwill-santosx%2Fquick-notes/lists"}