{"id":20201115,"url":"https://github.com/pheralb/typethings","last_synced_at":"2025-04-10T11:23:33.173Z","repository":{"id":192574454,"uuid":"680328853","full_name":"pheralb/typethings","owner":"pheralb","description":"✨ It's about Markdown. Write anything.","archived":false,"fork":false,"pushed_at":"2024-10-30T17:17:49.000Z","size":2710,"stargazers_count":49,"open_issues_count":0,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-03-24T10:11:14.677Z","etag":null,"topics":["editor","hacktoberfest","open-source","radix-ui","react","rust","tailwindcss","tauri","tauri-app","text-editor","typescript"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc0-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pheralb.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","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},"funding":{"github":["pheralb"]}},"created_at":"2023-08-18T23:15:25.000Z","updated_at":"2025-03-15T20:31:10.000Z","dependencies_parsed_at":"2024-02-01T12:47:53.620Z","dependency_job_id":null,"html_url":"https://github.com/pheralb/typethings","commit_stats":null,"previous_names":["pheralb/typethings"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Ftypethings","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Ftypethings/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Ftypethings/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pheralb%2Ftypethings/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pheralb","download_url":"https://codeload.github.com/pheralb/typethings/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208608,"owners_count":21065203,"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":["editor","hacktoberfest","open-source","radix-ui","react","rust","tailwindcss","tauri","tauri-app","text-editor","typescript"],"created_at":"2024-11-14T04:47:36.666Z","updated_at":"2025-04-10T11:23:33.142Z","avatar_url":"https://github.com/pheralb.png","language":"TypeScript","funding_links":["https://github.com/sponsors/pheralb"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\u003ca href=\"#\"\u003e\n\u003cimg src=\"website/public/images/screenshot_en.png\"\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\n\u003cp\u003e\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"#-download\"\u003e\n        Download\n    \u003c/a\u003e\n    \u003cspan\u003e\u0026nbsp;✦\u0026nbsp;\u003c/span\u003e\n    \u003ca href=\"#-getting-started\"\u003e\n        Getting Started\n    \u003c/a\u003e\n    \u003cspan\u003e\u0026nbsp;✦\u0026nbsp;\u003c/span\u003e\n    \u003ca href=\"#-whats-inside\"\u003e\n        What's inside?\n    \u003c/a\u003e\n    \u003cspan\u003e\u0026nbsp;✦\u0026nbsp;\u003c/span\u003e\n    \u003ca href=\"#packages\"\u003e\n        Packages\n    \u003c/a\u003e\n    \u003cspan\u003e\u0026nbsp;✦\u0026nbsp;\u003c/span\u003e\n    \u003ca href=\"#\" target=\"_blank\"\u003e\n        Website (soon)\n    \u003c/a\u003e\n    \u003cspan\u003e\u0026nbsp;✦\u0026nbsp;\u003c/span\u003e\n    \u003ca href=\"#-license\"\u003e\n        License\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003c/p\u003e\n\n\u003cdiv align=\"center\"\u003e\n\n![Tauri](https://img.shields.io/badge/Tauri-FFC131?style=flat\u0026logo=Tauri\u0026logoColor=white)\n[![GitHub actions](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fpheralb%2Ftypethings%2Fbadge%3Fref%3Dmain\u0026style=flat)](https://actions-badge.atrox.dev/pheralb/typethings/goto?ref=main)\n![GitHub stars](https://img.shields.io/github/stars/pheralb/typethings)\n![GitHub issues](https://img.shields.io/github/issues/pheralb/typethings)\n![GitHub forks](https://img.shields.io/github/forks/pheralb/typethings)\n![GitHub license](https://img.shields.io/github/license/pheralb/typethings)\n![tailwindcss](https://img.shields.io/badge/tailwindcss%20-0F172A?logo=tailwindcss\u0026style=flat\u0026labelColor=38bdf8\u0026logoColor=ffffff)\n\n\u003c/div\u003e\n\n\u003e [!IMPORTANT]\n\u003e This is a work-in-progress and not the finished product.\n\u003e Typethings will be constantly updated and is not yet ready for its first release.\n\n## \u003cimg src=\"app/public/images/logo.svg\" alt=\"Typethings logo\" height=\"18\" /\u003e\u0026nbsp;\u0026nbsp;Introduction\n\n[**Typethings**](#) is an open source markdown editor built with [Tauri](https://tauri.app) and [React](https://react.dev). It is designed to be a simple, fast and beautiful for everyone.\n\n- [x] Create, read, delete markdown files.\n- [x] Create and delete workspaces.\n- [x] Open markdown files from a specific directory.\n- [x] Show files from workspace.\n- [x] CMD + K to search app settings \u0026 files.\n- [x] Support code with syntax highlighting.\n- [x] Light and dark mode.\n- [x] Works completely offline.\n\n## 📦 Download\n\n**Download the latest release for your platform:**\n\n|     | Platform | Version                                                                      | Download |\n| --- | -------- | ---------------------------------------------------------------------------- | -------- |\n| ☁️  | Windows  | ![GitHub releases](https://img.shields.io/github/release/pheralb/typethings) | _Soon_   |\n| ☁️  | Linux    | ![GitHub releases](https://img.shields.io/github/release/pheralb/typethings) | _Soon_   |\n| ☁️  | MacOS    | ![GitHub releases](https://img.shields.io/github/release/pheralb/typethings) | _Soon_   |\n\n## 🚀 Getting Started\n\nTo get a local copy up and running, please follow these simple steps.\n\n**Prerequisites:**\n\n- [Node.js +18 (LTS recommended)](https://nodejs.org/). Then run `node --version` in your terminal to check if it's installed correctly.\n- [pnpm (we are using +8.8.0)](https://pnpm.io/). Install with npm: `npm i pnpm -g`. Then run `pnpm --version` in your terminal to check if it's installed correctly.\n- [Visual Studio Code](https://code.visualstudio.com/) (recommended) or [Lapce](https://lapce.dev/).\n- Only for Windows: [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/es/visual-cpp-build-tools/).\n- Rust. For Windows x64: [click here](https://static.rust-lang.org/rustup/dist/x86_64-pc-windows-msvc/rustup-init.exe). For Linux: [click here](https://forge.rust-lang.org/infra/other-installation-methods.html#other-ways-to-install-rustup). Then, run `rustc --version` in your terminal to check if it's installed correctly.\n\n**Setup:**\n\n1. Clone or [fork](https://github.com/pheralb/typethings/fork) this repository:\n\n```bash\ngit clone git@github.com:pheralb/typethings.git\n```\n\n2. Install dependencies:\n\n```bash\n# Access the project folder:\ncd typethings\n\n# Install dependencies:\npnpm install\n```\n\n3. Run the app:\n\n```bash\n# Run all monorepo apps, websites and packages:\npnpm dev\n\n# Run only website dev server:\npnpm dev:web\n```\n\n## 🤔 What's inside?\n\n### Desktop App:\n\nBuilt with:\n\n- [Tauri](https://tauri.studio/en/) - Build smaller, faster, and more secure desktop applications with a web frontend.\n- [React](https://reactjs.org/) - A JavaScript library for building user interfaces.\n- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - For state management in React.\n- [React Router v6](https://reactrouter.com/) - For routing in React.\n\n### Website:\n\nBuilt with:\n\n- [Next.js](https://nextjs.org/) - The React Framework for Production.\n- [@typethings/ui](https://github.com/pheralb/typethings/tree/main/packages/ui) - A set of accessible UI components.\n\n### Packages:\n\nFor all websites \u0026 apps:\n\n| Package                                                                                     | Description                                                                                                                                                 |\n| ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [@typethings/editor](https://github.com/pheralb/typethings/tree/main/packages/editor)       | An unstyled primitives based on [Tiptap](https://tiptap.dev/) for building your custom WYSIWYG editor.                                                      |\n| [@typethings/functions](https://github.com/pheralb/typethings/tree/main/packages/functions) | A set of files/folders functions using Tauri API.                                                                                                           |\n| [@typethings/ui](https://github.com/pheralb/typethings/tree/main/packages/ui)               | A set of accessible UI components. Built with [React](https://react.dev), [shadcn/ui](https://ui.shadcn.com/) and [Tailwind CSS](https://tailwindcss.com/). |\n| [@typethings/tailwind-config](https://github.com/pheralb/typethings/tree/main/packages/ui)  | [Tailwind CSS](https://tailwindcss.com/) configuration for Typethings App.                                                                                  |\n\n## 📝 License\n\n- [Apache License 2.0](https://github.com/pheralb/typethings/blob/main/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpheralb%2Ftypethings","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpheralb%2Ftypethings","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpheralb%2Ftypethings/lists"}