mirrors/TidGi-Desktop
1
Fork 0
mirror of https://github.com/tiddly-gittly/TidGi-Desktop.git synced 2025-12-06 02:30:47 -08:00
Code Issues Projects Releases Packages Wiki Activity
TidGi-Desktop/README.md
lin onetwo cdc47e2627
Update README.md
2020-07-19 20:45:42 +08:00

4.4 KiB
Raw Blame History

TiddlyGit License: MPL 2.0

macOS Linux Windows
GitHub Actions macOS Build Status GitHub Actions Linux Build Status GitHub Actions Windows Build Status

TiddlyGit - Customizable personal knowledge-base with Github as unlimited storage and blogging platform.

About TiddlyGit-Desktop

TiddlyGit is a cross-platform desktop app that make nodejs-TiddlyWiki easy to access.

Why Github?

Because Github is one of the best free civil BaaS:

  1. Its storage is basically free, allow us to store unlimited images and pdf files, which can have permanent URIs for public download
  2. It has GraphQL API that allow us programmatically update our wiki
  3. It has free CI to automatically deploy our TiddlyWiki blog
  4. It provides unlimited repository, public and private, which enables us to store private content into our TiddlyWiki

Why not TiddlyDesktop?

Main reasons:

  1. NodeJS version of TiddlyWiki have seamless auto-save experience, which is taking the advantage of SyncAdaptor instead of Syncer
  2. We can have separated tiddler files, which can be modified by hand, or by other programs
  3. Though TiddlyDesktop can load folder generated by nodejs-TiddlyWiki, it can't backup that folder to the Github easily

Development

Development plan of TiddlyGit-Desktop is listed in these Kanban.

Explanation of our code can be found in the Wiki.

To contribute, fork this repo, then clone it and setup development environment 
# First, clone the project:
git clone https://github.com/YOUR_ACCOUNT/TiddlyGit-Desktop.git
cd TiddlyGit-Desktop
# Or maybe you are just using Github Desktop
# or GitKraken to clone this repo,
# and open it in your favorite code editor and terminal app

# install the dependencies

npm i

# Run development mode

npm run electron-dev

# Build for production

npm run dist

Credits

The desktop app shell is based on https://github.com/atomery/singlebox and atomery/webcatalog, they provide lots of utils around website-generated-app, much powerful than generating app from website simply using Chrome. Also the independent developer @quanglam2807 behind these great tools helps me a lot when I develop TiddlyGit.

Current Icon is download from iconsdb under Creative Commons Attribution-NoDerivs 3.0 , if you are a designer, please feel free to contribute your ICON if you have a better idea.