{"id":18729422,"url":"https://github.com/alexwkleung/iris","last_synced_at":"2025-04-12T16:53:10.987Z","repository":{"id":155670071,"uuid":"578287144","full_name":"alexwkleung/Iris","owner":"alexwkleung","description":"✨ A comfortable note-taking app powered by Markdown","archived":false,"fork":false,"pushed_at":"2024-04-13T06:30:28.000Z","size":20227,"stargazers_count":10,"open_issues_count":34,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-14T00:53:13.244Z","etag":null,"topics":["codemirror","codemirror-editor","electron","electron-app","electron-application","local-apps","local-first","macos","markdown","markdown-editor","napi","napi-rs","note-taking","note-taking-app","notes-app","prosemirror","rust","typescript","wysiwyg","wysiwyg-editor"],"latest_commit_sha":null,"homepage":"https://irisnotes.vercel.app/","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/alexwkleung.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}},"created_at":"2022-12-14T17:39:43.000Z","updated_at":"2024-04-15T06:57:46.609Z","dependencies_parsed_at":"2023-10-14T18:35:20.212Z","dependency_job_id":"def5cc54-4c1f-420e-8363-40c18dfe9bc9","html_url":"https://github.com/alexwkleung/Iris","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexwkleung%2FIris","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexwkleung%2FIris/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexwkleung%2FIris/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/alexwkleung%2FIris/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/alexwkleung","download_url":"https://codeload.github.com/alexwkleung/Iris/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248601327,"owners_count":21131608,"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":["codemirror","codemirror-editor","electron","electron-app","electron-application","local-apps","local-first","macos","markdown","markdown-editor","napi","napi-rs","note-taking","note-taking-app","notes-app","prosemirror","rust","typescript","wysiwyg","wysiwyg-editor"],"created_at":"2024-11-07T14:27:05.051Z","updated_at":"2025-04-12T16:53:10.966Z","avatar_url":"https://github.com/alexwkleung.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1 align=\"center\" style=\"border-bottom: none\"\u003e\n\u003cbr\u003e\n\u003ca href=\"https://irisnotes.vercel.app\"\u003eIris\u003c/a\u003e\n\u003cbr\u003e\n\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eˈaɪərɪs | eye-riss\u003c/em\u003e\n\u003cbr\u003e\n\u003cbr\u003e\n    A comfortable note-taking app powered by Markdown that introduces a elegant note-taking experience.\n\u003cbr\u003e\n    Always local-first, open-source, and free forever.\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003cimg src=\"https://img.shields.io/github/downloads/alexwkleung/Iris/total\"\u003e\u003c/img\u003e\n    \u003cimg src=\"https://img.shields.io/github/package-json/v/alexwkleung/Iris/main\"\u003e\u003c/img\u003e\n    \u003cimg src=\"https://img.shields.io/github/license/alexwkleung/Iris\"\u003e\u003c/img\u003e\n\u003c/p\u003e\n\n\u003ch4 align=\"center\"\u003e\n    \u003ca href=\"https://discord.gg/z9QmRgJsmc\" style=\"border-bottom: none\"\u003eDiscord\u003c/a\u003e\n\u003c/h4\u003e\n\n\u003cimg align=\"center\" src=\"./screenshots/v0.2.0-dev-4.3-1.png\"\u003e\u003c/img\u003e\n\u003cimg align=\"center\" src=\"./screenshots/v0.2.0-dev-4.3-2.png\"\u003e\u003c/img\u003e\n\u003cimg align=\"center\" src=\"./screenshots/v0.2.0-dev-4.3-3.png\"\u003e\u003c/img\u003e\n\n# Info\n\nThe app is currently in early development and may not be 100% stable for daily use. The source code could go through a handful of iterations and subsequent releases may not be backward compatible.\n\nOnly macOS installers will be supplied in the early development phase and official release (v1.0.0). Other platforms are not supported but is considered in the future roadmap.\n\n# Contact \n\nJoin the [Discord](https://discord.gg/z9QmRgJsmc) to chat with others in the community.\n\nFor professional mediums, you can contact via email (expect 24-48 hour reply time): irisnotesapp@gmail.com \n\n[GitHub Discussions](https://github.com/alexwkleung/Iris/discussions) is also an alternative to the above contact methods.\n\n# Installation\n\nYou can install the latest dev builds from [releases](https://github.com/alexwkleung/Iris/releases).\n\nIf you want to build the app directly from source, follow the instructions in [Development](#development).\n \n# Development \n\nThe recommended editor for development is [VS Code](https://code.visualstudio.com/)\n\nInstall [Node.js](https://nodejs.org/en/download)\n\nInstall [Rust](https://www.rust-lang.org/tools/install)\n\nIf you are cross-compiling the native modules for other platforms, you'll need to install the corresponding target if it isn't already installed:\n\n```bash\n# check target list\nrustc --print target-list\n\n# install target\nrustup target install \u003ctarget\u003e\n\n# Apple Silicon:\nrustup target install x86_64-apple-darwin\n\n# Intel Architecture:\nrustup target install aarch64-apple-darwin\n```\n\nThe recommended build tool for Iris is [GNU Make](https://www.gnu.org/software/make/). All build steps or commands will be reflected in the `makefile`. At the moment, only a small set of commands have a `npm run` script counterpart.\n\n```bash\n# for example: install Xcode Command Line Tools on macOS (includes GNU Make)\nxcode-select --install \n```\n\nClone the repository\n\n```bash \ngit clone \u003cSSH/HTTPS URL\u003e\n```\n\nChange directory \n\n```bash\ncd \u003c...\u003e/Iris\n```\n\nInstall npm dependencies. Only do this in the *root* of the project. Do not `npm install` inside of the native modules.\n\n```bash\nnpm install \n```\n\nIt recommended to add these to your VS Code `settings.json`:\n\n```json\n\"editor.codeActionsOnSave\": {\n    \"source.fixAll.eslint\": \"always\",\n    \"editor.formatOnSave\": \"always\",\n},\n\"prettier.enable\": true,\n```\n\nBuild native modules\n\n```bash\n# change directory to native module\ncd fs-mod\n\n# if you are planning to build a universal binary, you must have the native module for both x64 and arm64\n\n# execute one of the build commands below:\n\n# build native module for your platform (automatic)\nnpm run build\n# build native module for macOS x64\nnpm run build-x64\n# build native module for macOS arm64\nnpm run build-arm64\n\n# go back to previous directory (assuming Iris root)\ncd -\n```\n\nRun development server. The dev tools is undocked by default.\n\n```bash\n# via make \nmake dev\n\n# via npm\nnpm run dev\n```\n\nBuild the installer \n\n```bash\n# via make (x64)\nmake build-mac-x64\n\n# via make (arm64)\nmake build-mac-arm64\n\n# via make (universal)\nmake build-mac-universal\n\n# via npm (x64)\nnpm run build:mac-x64\n\n# via npm (universal)\nnpm run build:mac-universal\n\n# via npm (arm64)\nnpm run build:mac-arm64\n```\n\n# Contributing\n\nHere are a list of ways you can contribute to Iris:\n\n1. [Submit a pull request](https://github.com/alexwkleung/Iris/pulls)\n2. [Create or answer issues](https://github.com/alexwkleung/Iris/issues)\n3. [Create or answer discussion posts](https://github.com/alexwkleung/Iris/discussions)\n4. Show your interest by sharing Iris to others :)\n\n# License \n\n[MIT License.](https://github.com/alexwkleung/Iris/blob/main/LICENSE)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexwkleung%2Firis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falexwkleung%2Firis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falexwkleung%2Firis/lists"}