{"id":13511922,"url":"https://github.com/TiddlyWiki/TiddlyDesktop","last_synced_at":"2025-03-30T21:31:11.982Z","repository":{"id":13063069,"uuid":"15743523","full_name":"TiddlyWiki/TiddlyDesktop","owner":"TiddlyWiki","description":"A custom desktop browser for TiddlyWiki 5 and TiddlyWiki Classic, based on nw.js","archived":false,"fork":false,"pushed_at":"2024-06-30T17:14:54.000Z","size":3279,"stargazers_count":1703,"open_issues_count":138,"forks_count":124,"subscribers_count":82,"default_branch":"master","last_synced_at":"2024-10-29T15:34:36.008Z","etag":null,"topics":["hacktoberfest","javascript","nwjs","tiddlywiki"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TiddlyWiki.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2014-01-08T18:08:31.000Z","updated_at":"2024-10-28T12:44:01.000Z","dependencies_parsed_at":"2024-03-09T16:31:41.728Z","dependency_job_id":"f8099dd9-a948-4061-a407-0b617a07dd6c","html_url":"https://github.com/TiddlyWiki/TiddlyDesktop","commit_stats":null,"previous_names":["jermolene/tiddlydesktop"],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiddlyWiki%2FTiddlyDesktop","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiddlyWiki%2FTiddlyDesktop/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiddlyWiki%2FTiddlyDesktop/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TiddlyWiki%2FTiddlyDesktop/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TiddlyWiki","download_url":"https://codeload.github.com/TiddlyWiki/TiddlyDesktop/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246385133,"owners_count":20768663,"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":["hacktoberfest","javascript","nwjs","tiddlywiki"],"created_at":"2024-08-01T03:01:19.514Z","updated_at":"2025-03-30T21:31:11.976Z","avatar_url":"https://github.com/TiddlyWiki.png","language":"JavaScript","readme":"# TiddlyDesktop\n\nTiddlyDesktop is a special purpose web browser for working with locally stored TiddlyWikis. See http://tiddlywiki.com/ for more details of TiddlyWiki.\n\nSee this video tutorial for an overview of installing and using TiddlyDesktop on Windows and OS X:\n\nhttps://www.youtube.com/watch?v=i3Bggkm7paA\n\nIt is based on nw.js, a project created and developed in the Intel Open Source Technology Center:\n\nhttps://github.com/nwjs/nw.js\n\n# Download and Install\n\nDownload the Windows, linux or Mac binary .zip files from:\n\nhttps://github.com/TiddlyWiki/TiddlyDesktop/releases\n\nUnzip into a folder and run `TiddlyWiki.app` or `nw.exe` and for linux `nw`\n\nNote that TiddlyDesktop will not work correctly from a Windows UNC network share (eg ``\\\\MY-SERVER\\SHARE\\MyFolder``). You should map the network share to a local drive, and run it from there.\n\n## Linux AppImage\n\nLinux releases are also available in the AppImage format. The AppImages are compatible with glibc-based Desktop Linux distributions such as Ubuntu, Fedora, and Arch Linux. The AppImages are _not_ compatible with musl-based Linux distributions such as Alpine Linux, nor are they compatible with Linux server distributions; Server distributions don't provide enough of the required dependencies.\n\nTo use an AppImage, your Linux distribution must provide `fusermount3`, which is typically provided in a package named `fuse3`.\n\nBefore you can execute an AppImage, you must set the executable permission:\n\n```\nchmod u+x tiddlydesktop-*-v*.AppImage\n```\n\n## NixOS\n\nTo install TiddlyDesktop on NixOS, you first need to add this repo to your `configuration.nix`; Using a `let` expression at the top of the file is a good approach: \n\n```\nlet\n  twdesktop = let\n    rev = \"Set this to the TiddlyDesktop Git revision that you want to install.\";\n  in import (fetchTarball \"https://github.com/TiddlyWiki/TiddlyDesktop/archive/${rev}.tar.gz\") { };\nin\n ...\n``` \n\nThen add the attribute name (which is twdesktop in the example above) to your `systemPackages`:\n\n```\n...\nenvironment.systemPackages = with pkgs; [\n   ...\n   twdesktop\n];\n...\n```\n\nIn addition to the method described above, the tiddlydesktop package is available as a Nix Flake; See https://wiki.nixos.org/wiki/Flakes to read more about Flakes. Simply use the Flake input `github:TiddlyWiki/TiddlyDesktop`. For example, you can run TiddlyDesktop with the command `nix run github:TiddlyWiki/TiddlyDesktop`.\n\n# Usage\n\n## Multiple Configurations\n\nTo have separate mutliple instances of TiddlyDesktop (for example, separate Personal and Professional instances), you can pass the `--user-data-dir` argument.  e.g. `/opt/TiddlyDesktop/nw --user-data-dir=/mnt/data/TiddlyWiki/config`.  The property should be a directory to use for holding configuration data.\n\n## Developer Tools\n\nThe F12 key opens the Chromium developer tools for the current window.\n\n## Debugging With VSCode\n\nInstructions for Windows 10 64-bit (updates for other OSs welcome).\n\n* Required software: VScode, Debugger for NWjs plugin installed in vscode\n* Download the latest version of TiddlyDesktop-win64-v0.0.15 and unzip it to keep only four folders: html, images, js, tiddlywiki and package.json file\n* Download nwjs-sdk-v0.69.1-win-x64, put it in C:\\Users\\your username\\.nwjs folder and unzip it. After unzipping you can see the nw.exe program in the .nwjs\\nwjs-sdk-v0.69.1-win-x64 folder to indicate that it is correct. (Again, you can use Ctrl + shift + p in vscode to bring up the command to execute the NWjs Install command and select the version to install)\n* Use vscode to open the TiddlyDesktop-win64 folder\n* Modify the \"main\" field in the package.json file to \"html/main.html\"\n* Click 'Debug' and select nwjs to automatically create the configuration file laugh.json (no need to modify it). Then click Start to debug.\n\n# Releasing with Continuous Integration\n\n1. Update the version number in package.json, plus any other changes that should be included\n2. Run `npm install --save`\n2. Make a commit and push it\n3. Check the build output in the GitHub Actions tab\n3. Tag that commit with `git tag v0.0.21`, the version number you just updated in package.json\n4. Push that tag with `git push v0.0.21` and a draft release will be created\n5. Edit the draft release: add release notes, edit whatever else might need to be changed. Download its build files and test them\n6. Switch the draft release to be a public release once it's tested and ready\n\n# Building\n\n1. Run `download-nwjs.sh` to download the latest nw.js binaries\n2. Download the TiddlyWiki5 repo from https://github.com/Jermolene/TiddlyWiki5 to a sibling directory to the TiddlyDesktop repo called \"TiddlyWiki5\"\n3. Run `bld.sh`\n4. Execute `output/mac/TiddlyWiki.app` or `output/win/nw.exe` or `output/linux32/nw` or `output/linux64/nw`\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTiddlyWiki%2FTiddlyDesktop","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTiddlyWiki%2FTiddlyDesktop","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTiddlyWiki%2FTiddlyDesktop/lists"}