Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pheralb/typethings
✍️ [WIP] A modern, minimal markdown editor built with Tauri.
https://github.com/pheralb/typethings
editor hacktoberfest open-source radix-ui react rust tailwindcss tauri tauri-app text-editor typescript
Last synced: 3 months ago
JSON representation
✍️ [WIP] A modern, minimal markdown editor built with Tauri.
- Host: GitHub
- URL: https://github.com/pheralb/typethings
- Owner: pheralb
- License: cc0-1.0
- Created: 2023-08-18T23:15:25.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-21T16:53:31.000Z (10 months ago)
- Last Synced: 2024-07-30T20:49:46.319Z (6 months ago)
- Topics: editor, hacktoberfest, open-source, radix-ui, react, rust, tailwindcss, tauri, tauri-app, text-editor, typescript
- Language: TypeScript
- Homepage:
- Size: 2.85 MB
- Stars: 36
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://actions-badge.atrox.dev/pheralb/typethings/goto?ref=main)
> [!IMPORTANT]
> This is a work-in-progress and not the finished product.
> Typethings will be constantly updated and is not yet ready for its first release.
## 
Introduction
[**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.
- [x] Create, read, delete markdown files.
- [x] Create and delete workspaces.
- [x] Open markdown files from a specific directory.
- [x] Show files from workspace.
- [x] CMD + K to search app settings & files.
- [x] Support code with syntax highlighting.
- [x] Light and dark mode.
- [x] Works completely offline.
## 📦 Download
**Download the latest release for your platform:**
| | Platform | Version | Download |
| --- | -------- | ---------------------------------------------------------------------------- | -------- |
| ☁️ | Windows |  | _Soon_ |
| ☁️ | Linux |  | _Soon_ |
| ☁️ | MacOS |  | _Soon_ |
## 🚀 Getting Started
To get a local copy up and running, please follow these simple steps.
**Prerequisites:**
- [Node.js +18 (LTS recommended)](https://nodejs.org/). Then run `node --version` in your terminal to check if it's installed correctly.
- [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.
- [Visual Studio Code](https://code.visualstudio.com/) (recommended) or [Lapce](https://lapce.dev/).
- Only for Windows: [Microsoft C++ Build Tools](https://visualstudio.microsoft.com/es/visual-cpp-build-tools/).
- 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.
**Setup:**
1. Clone or [fork](https://github.com/pheralb/typethings/fork) this repository:
```bash
git clone [email protected]:pheralb/typethings.git
```
2. Install dependencies:
```bash
# Access the project folder:
cd typethings
# Install dependencies:
pnpm install
```
3. Run the app:
```bash
# Run all monorepo apps, websites and packages:
pnpm dev
# Run only website dev server:
pnpm dev:web
```
## 🤔 What's inside?
### Desktop App:
Built with:
- [Tauri](https://tauri.studio/en/) - Build smaller, faster, and more secure desktop applications with a web frontend.
- [React](https://reactjs.org/) - A JavaScript library for building user interfaces.
- [Zustand](https://docs.pmnd.rs/zustand/getting-started/introduction) - For state management in React.
- [React Router v6](https://reactrouter.com/) - For routing in React.
### Website:
Built with:
- [Next.js](https://nextjs.org/) - The React Framework for Production.
- [@typethings/ui](https://github.com/pheralb/typethings/tree/main/packages/ui) - A set of accessible UI components.
### Packages:
For all websites & apps:
| Package | Description |
| ------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [@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. |
| [@typethings/functions](https://github.com/pheralb/typethings/tree/main/packages/functions) | A set of files/folders functions using Tauri API. |
| [@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/). |
| [@typethings/tailwind-config](https://github.com/pheralb/typethings/tree/main/packages/ui) | [Tailwind CSS](https://tailwindcss.com/) configuration for Typethings App. |
## 📝 License
- [Apache License 2.0](https://github.com/pheralb/typethings/blob/main/LICENSE).