{"id":19519598,"url":"https://github.com/the-best-codes/codequill","last_synced_at":"2025-04-26T07:31:19.093Z","repository":{"id":249259741,"uuid":"827077972","full_name":"The-Best-Codes/codequill","owner":"The-Best-Codes","description":"Organize, edit, and preview code efficiently","archived":false,"fork":false,"pushed_at":"2025-03-31T14:24:28.000Z","size":2003,"stargazers_count":14,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-04T09:44:43.588Z","etag":null,"topics":["ai","artificial-intelligence","css","database","javascript","local","nodejs","organization","organizer","rust","share","storage","syntax","syntax-highlighting","tauri","typescript","ui"],"latest_commit_sha":null,"homepage":"","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/The-Best-Codes.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}},"created_at":"2024-07-11T01:35:03.000Z","updated_at":"2025-03-31T14:58:40.000Z","dependencies_parsed_at":"2024-08-24T22:42:15.175Z","dependency_job_id":"e0685a52-b509-4ce1-a67f-7b6fceff6424","html_url":"https://github.com/The-Best-Codes/codequill","commit_stats":null,"previous_names":["the-best-codes/codequill"],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fcodequill","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fcodequill/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fcodequill/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/The-Best-Codes%2Fcodequill/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/The-Best-Codes","download_url":"https://codeload.github.com/The-Best-Codes/codequill/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250953455,"owners_count":21513351,"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":["ai","artificial-intelligence","css","database","javascript","local","nodejs","organization","organizer","rust","share","storage","syntax","syntax-highlighting","tauri","typescript","ui"],"created_at":"2024-11-11T00:19:20.802Z","updated_at":"2025-04-26T07:31:19.082Z","avatar_url":"https://github.com/The-Best-Codes.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg src=\"./assets/images/icon.svg\" alt=\"CodeQuill Logo\" for=\"cover\" width=\"80\" height=\"80\" /\u003e\n\n# CodeQuill\n\n_Organize, edit, and preview code efficiently._\n\n![CodeQuill Main Promo](./assets/images/promo_screenshot_main.png)\n\n[![Get it from the Snap Store](https://snapcraft.io/en/light/install.svg)](https://snapcraft.io/codequill)\n\nBuilt with Tauri 2, CodeQuill offers a rich editing experience with syntax highlighting for over 90 programming languages and built-in previews for Markdown and HTML.\nWhether you're a seasoned developer or just starting out, CodeQuill helps you organize, edit, and preview your code with ease.\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n  - [Prerequisites](#prerequisites)\n  - [Platform-Specific Installation](#platform-specific-installation)\n    - [Linux](#linux)\n    - [Windows](#windows)\n    - [macOS](#macos)\n  - [Snap Store](#snap-store)\n  - [Flathub (Coming Soon)](#flathub-coming-soon)\n- [Updating](#updating)\n  - [Linux (Debian-based)](#linux-debian-based)\n- [Migrating from CodeQuill v1](#migrating-from-codequill-v1)\n- [Usage](#usage)\n  - [Key Features](#key-features)\n    - [Rich Text Editor](#rich-text-editor)\n    - [Syntax Highlighting](#syntax-Highlighting)\n    - [Built-in Previews](#built-in-previews)\n- [Contributing](#contributing)\n  - [Getting Started](#getting-started)\n  - [Development Setup](#development-setup)\n  - [Dependencies](#dependencies)\n  - [Coding Style](#coding-style)\n- [License](#license)\n\n---\n\n## Installation\n\n### Prerequisites\n\nBefore installing CodeQuill, ensure you have the necessary prerequisites installed on your system. These may include:\n\n- A modern operating system (Windows 8+, macOS 10.13+, or a recent Linux distribution). While CodeQuill aims for cross-platform compatibility, Windows 7 may not be fully supported.\n- Sufficient system resources (RAM and storage) to run a desktop application.\n\n### Platform-Specific Installation\n\nChoose the installation method that best suits your operating system.\n\n#### Linux\n\n1.  Download the latest `.deb` package from the [Releases](https://github.com/The-Best-Codes/codequill/releases) page.\n2.  Open a terminal and navigate to the directory where you downloaded the package.\n3.  Install the package using `dpkg`:\n\n    ```bash\n    sudo dpkg -i codequill_\u003cversion\u003e_\u003carchitecture\u003e.deb\n    ```\n\n    Replace `\u003cversion\u003e` and `\u003carchitecture\u003e` with the actual values from the filename.\n\n4.  If you encounter dependency issues, run:\n\n    ```bash\n    sudo apt-get install -f\n    ```\n\n#### Windows\n\nThere are usually both `.msi` and `.exe` installers available for Windows. Both should be compatible with most Windows versions.\n\n1.  Download the latest `.msi` or `.exe` installer from the [Releases](https://github.com/The-Best-Codes/codequill/releases) page.\n2.  Double-click the downloaded file and follow the on-screen instructions.\n\n#### macOS\n\n1.  Download the latest `.dmg` file from the [Releases](https://github.com/The-Best-Codes/codequill/releases) page.\n2.  Double-click the downloaded file and drag the CodeQuill icon to your Applications folder.\n\n### Snap Store\n\n[![Get it from the Snap Store](https://snapcraft.io/en/light/install.svg)](https://snapcraft.io/codequill)\n\nCodeQuill is now available on the Snap Store!\n\nSearch 'codequill' in the Snap Store and click 'Install', or run the following command in a terminal:\n\n```bash\nsudo snap install codequill\n```\n\n### Flathub (Coming Soon)\n\nCodeQuill will soon be available on Flathub. Check back later for installation instructions.\n\n---\n\n## Updating\n\n### Linux (Debian-based)\n\n1.  Download the latest `.deb` package from the [Releases](https://github.com/The-Best-Codes/codequill/releases) page.\n2.  Open a terminal and navigate to the directory where you downloaded the package.\n3.  Upgrade the package using `dpkg`:\n\n    ```bash\n    sudo dpkg -i codequill_\u003cversion\u003e_\u003carchitecture\u003e.deb\n    ```\n\n    This will install the new version while preserving your settings.\n\n---\n\n## Migrating from CodeQuill v1\n\nAll CodeQuill v1 releases are not compatible with CodeQuill v2.\nYou should uninstall CodeQuill v1 before installing CodeQuill v2.\nYou can do so by running the `codequill.sh` script (or right-clicking on the app icon, then selecting `CodeQuill Manager`), then choosing the \"Uninstall\" option.\n\nYou may want to back up the old database or your currently saved snippets before uninstalling.\nThere is currently no way except a manual migration to transfer your data to CodeQuill v2, though we may provide a migration tool in the future.\nYou can likely find your data for the old application in `~/codequill/`.\n\n---\n\n## Usage\n\nUsage is quite straightforward. After launching CodeQuill, you can click the \"New Snippet\" button to create your first snippet.\nI'd also recommend checking out settings and search to familiarize yourself with the app.\n\n![Settings in Dark Mode](./assets/images/usage_settings_screenshot_dark.png)\n\n### Key Features\n\nCodeQuill is designed to be intuitive and powerful. Here are some of its key features:\n\n#### Rich Text Editor\n\nCodeQuill's core is a fully-featured text editor, Monaco, providing a smooth and responsive coding experience.\n\n#### Syntax Highlighting\n\nEnjoy syntax highlighting for over 90 programming languages, making your code easier to read and understand.\n\n#### Built-in Previews\n\nQuickly preview your Markdown and HTML files directly within CodeQuill. Preview panes update live for easy testing and debugging.\n\n---\n\n## Contributing\n\nWe welcome contributions from the community! Here's how you can get involved:\n\n### Getting Started\n\n1.  Fork the repository on [GitHub](https://github.com/The-Best-Codes/codequill).\n2.  Clone your forked repository to your local machine:\n\n    ```bash\n    git clone https://github.com/\u003cyour-username\u003e/codequill.git\n    ```\n\n3.  Create a new branch for your feature or bug fix:\n\n    ```bash\n    git checkout -b feature/your-feature-name\n    ```\n\n### Development Setup\n\nBefore performing the following steps, ensure you have installed the Tauri 2 prerequisites.\nYou can find out more on the [Tauri website](https://v2.tauri.app/start/prerequisites/).\n\n1.  Install Node.js and npm if you haven't already. It's recommended to use the latest LTS version of Node.js.\n2.  Navigate to the project directory in your terminal.\n3.  Install the project dependencies:\n\n    ```bash\n    npm install\n    ```\n\n4.  Start the development server:\n\n    ```bash\n    npm run tauri dev\n    ```\n\n### Dependencies\n\nCodeQuill relies on the following major dependencies:\n\n- **Tauri 2:** The framework for building cross-platform desktop applications.\n- **React:** A JavaScript library for building user interfaces.\n- **Tailwind CSS:** A utility-first CSS framework.\n- **Shadcn UI:** A collection of accessible and reusable UI components built with Radix UI and Tailwind CSS.\n\n### Coding Style\n\nWhile we don't enforce strict coding style guidelines, we encourage you to follow these recommendations:\n\n- Don't format files that you haven't modified. This is low effort and can lead to a more cluttered PR review process.\n- Write clear and concise code.\n- Add comments to explain complex logic. Your comments may be removed later.\n\n---\n\n## License\n\nCodeQuill is released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-best-codes%2Fcodequill","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthe-best-codes%2Fcodequill","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthe-best-codes%2Fcodequill/lists"}