{"id":20773026,"url":"https://github.com/tnar/algobreath","last_synced_at":"2026-05-01T22:33:57.538Z","repository":{"id":257669298,"uuid":"737436423","full_name":"tnar/algobreath","owner":"tnar","description":"AlgoBreath is a modern, markdown-based note-taking web application built with Remix and deployed on Cloudflare Pages. It offers seamless creation, management, and organization of notes with robust tagging functionality.","archived":false,"fork":false,"pushed_at":"2024-09-17T21:46:25.000Z","size":641,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-12-26T10:48:11.364Z","etag":null,"topics":["cloudflare-pages","d1","daisyui","react","remix","tailwind","typescript"],"latest_commit_sha":null,"homepage":"https://www.algobreath.com","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/tnar.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":"2023-12-31T02:55:42.000Z","updated_at":"2024-09-18T01:02:26.000Z","dependencies_parsed_at":"2024-09-18T02:34:58.127Z","dependency_job_id":"5932f3c1-b2b5-4b90-b7f9-c7a935a3eb63","html_url":"https://github.com/tnar/algobreath","commit_stats":null,"previous_names":["tnar/algobreath"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/tnar/algobreath","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnar%2Falgobreath","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnar%2Falgobreath/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnar%2Falgobreath/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnar%2Falgobreath/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tnar","download_url":"https://codeload.github.com/tnar/algobreath/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tnar%2Falgobreath/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32515838,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-30T13:12:12.517Z","status":"online","status_checked_at":"2026-05-01T02:00:05.856Z","response_time":64,"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":["cloudflare-pages","d1","daisyui","react","remix","tailwind","typescript"],"created_at":"2024-11-17T12:23:58.586Z","updated_at":"2026-05-01T22:33:57.521Z","avatar_url":"https://github.com/tnar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AlgoBreath\n\nAlgoBreath is a modern, markdown-based note-taking web application built with [Remix](https://remix.run/) and deployed on [Cloudflare Pages](https://pages.cloudflare.com/). It offers seamless creation, management, and organization of notes with robust tagging functionality.\n\n## Features\n\n- **Markdown Support**: Write and preview notes in markdown with syntax highlighting and LaTeX support.\n- **Tagging System**: Organize notes using tags for easy categorization and retrieval.\n- **Admin Dashboard**: Manage notes and tags through an intuitive administrative interface.\n- **Responsive Design**: Optimized for all devices using Tailwind CSS and DaisyUI.\n- **SEO Optimized**: Automatically generated sitemap and meta tags for improved search engine visibility.\n- **Cloudflare Integration**: Leveraging Cloudflare Workers and D1 for a performant and scalable backend.\n\n## Tech Stack\n\n- **Framework**: [Remix](https://remix.run/)\n- **Frontend**: [React](https://reactjs.org/)\n- **Styling**: [Tailwind CSS](https://tailwindcss.com/) with [DaisyUI](https://daisyui.com/)\n- **Type Checking**: [TypeScript](https://www.typescriptlang.org/)\n- **Syntax Highlighting**: [Highlight.js](https://highlightjs.org/)\n- **Mathematical Notation**: [KaTeX](https://katex.org/)\n- **Backend**: [Cloudflare Workers](https://workers.cloudflare.com/) with [D1 Database](https://developers.cloudflare.com/d1/)\n- **Deployment**: [Cloudflare Pages](https://pages.cloudflare.com/)\n- **Linting**: [ESLint](https://eslint.org/) with [TypeScript ESLint](https://typescript-eslint.io/)\n\n## Getting Started\n\n### Prerequisites\n\n- [Node.js](https://nodejs.org/) (v18 or higher)\n- [npm](https://www.npmjs.com/)\n- [Cloudflare Account](https://dash.cloudflare.com/sign-up) with Workers and Pages enabled\n\n### Installation\n\n1. **Clone the repository:**\n\n   ```bash\n   git clone https://github.com/yourusername/algobreath.git\n   cd algobreath\n   ```\n\n2. **Install dependencies:**\n\n   ```bash\n   npm install\n   ```\n\n3. **Configure Environment Variables:**\n\n   Create a `.env` file in the root directory and add the following:\n\n   ```env\n   WORKER_HOST=your_worker_host_url\n   DB=your_d1_database_url\n   ```\n\n### Development\n\nAlgoBreath uses Wrangler to emulate the Cloudflare runtime locally.\n\n1. **Start the development server:**\n\n   ```bash\n   npm run dev\n   ```\n\n2. **Access the application:**\n\n   Open [http://127.0.0.1:8788](http://127.0.0.1:8788) in your browser.\n\n### Scripts\n\n- **Build the application:**\n\n  ```bash\n  npm run build\n  ```\n\n- **Start the development server:**\n\n  ```bash\n  npm run dev\n  ```\n\n- **Lint the codebase:**\n\n  ```bash\n  npm run lint\n  ```\n\n- **Type check:**\n\n  ```bash\n  npm run typecheck\n  ```\n\n- **Deploy to Cloudflare Pages:**\n\n  ```bash\n  npm run pages:deploy\n  ```\n\n### Deployment\n\nAlgoBreath is deployed on Cloudflare Pages. To deploy your changes:\n\n1. **Build the application:**\n\n   ```bash\n   npm run build\n   ```\n\n2. **Deploy using Wrangler:**\n\n   ```bash\n   npm run pages:deploy\n   ```\n\nEnsure your Cloudflare account is properly configured with the necessary environment variables.\n\n## Project Structure\n\n- **`app/`**: Contains all frontend and server-side code.\n  - **`routes/`**: Defines all application routes.\n  - **`models/`**: Handles data fetching and manipulation.\n  - **`utils/`**: Utility functions like markdown parsing.\n  - **`styles/`**: Tailwind CSS configurations and styles.\n- **`public/`**: Static assets like images and manifest files.\n- **`server.ts`**: Entry point for the Cloudflare Workers server.\n- **`.gitignore`**: Specifies intentionally untracked files to ignore.\n- **`package.json`**: Project metadata and dependencies.\n- **`tailwind.config.ts`**: Tailwind CSS configuration.\n- **`tsconfig.json`**: TypeScript configuration.\n\n## Contributing\n\nContributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.\n\n1. **Fork the repository**\n2. **Create a new branch**\n\n   ```bash\n   git checkout -b feature/YourFeature\n   ```\n\n3. **Commit your changes**\n\n   ```bash\n   git commit -m \"Add some feature\"\n   ```\n\n4. **Push to the branch**\n\n   ```bash\n   git push origin feature/YourFeature\n   ```\n\n5. **Open a Pull Request**\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n\n## Acknowledgements\n\n- Built with love using Remix, React, and Cloudflare.\n- Inspired by modern web development best practices.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftnar%2Falgobreath","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftnar%2Falgobreath","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftnar%2Falgobreath/lists"}