typethings

Download  ✦  Getting Started  ✦  What's inside?  ✦  Packages  ✦  Website (soon)  ✦  License

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 and React. It is designed to be a simple, fast and beautiful for everyone.

• Create, read, delete markdown files.
• Create and delete workspaces.
• Open markdown files from a specific directory.
• Show files from workspace.
• CMD + K to search app settings & files.
• Support code with syntax highlighting.
• Light and dark mode.
• 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). Then run node --version in your terminal to check if it's installed correctly.
• pnpm (we are using +8.8.0). Install with npm: npm i pnpm -g. Then run pnpm --version in your terminal to check if it's installed correctly.
• Visual Studio Code (recommended) or Lapce.
• Only for Windows: Microsoft C++ Build Tools.
• Rust. For Windows x64: click here. For Linux: click here. Then, run rustc --version in your terminal to check if it's installed correctly.

Setup:

1. Clone or fork this repository:

git clone git@github.com:pheralb/typethings.git

1. Install dependencies:

# Access the project folder:
cd typethings

# Install dependencies:
pnpm install

1. Run the app:

# 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 - Build smaller, faster, and more secure desktop applications with a web frontend.
• React - A JavaScript library for building user interfaces.
• Zustand - For state management in React.
• React Router v6 - For routing in React.

Website:

Built with:

• Next.js - The React Framework for Production.
• @typethings/ui - A set of accessible UI components.

Packages:

For all websites & apps:

Package	Description
@typethings/editor	An unstyled primitives based on Tiptap for building your custom WYSIWYG editor.
@typethings/functions	A set of files/folders functions using Tauri API.
@typethings/ui	A set of accessible UI components. Built with React, shadcn/ui and Tailwind CSS.
@typethings/tailwind-config	Tailwind CSS configuration for Typethings App.

📝 License

• Apache License 2.0.