mirrors/TidGi-Desktop
1
Fork 0
mirror of https://github.com/tiddly-gittly/TidGi-Desktop.git synced 2025-12-15 15:10:31 -08:00
Code Issues Projects Releases Packages Wiki Activity
TidGi is an privatcy-in-mind, automated, auto-git-backup, freely-deployed Tiddlywiki knowledge management Desktop note app, with local REST API. 「 太记 」是一个基于「 太微 TiddlyWiki 」的知识管理桌面应用，能保护隐私内容、高级自动化、自动Git云备份、部署为博客，且可通过RESTAPI与Anki等应用连接。（迭代开发中欢迎试用，开发进度见下方链接）(Under active development, see website below for details)
406 commits 29 branches 292 tags 77 MiB
Find a file
Lin Onetwo d3e561771e chore: upgrade to electron v9
2020-07-13 00:17:42 +08:00
.github chore: use npm in github action 2020-06-27 14:34:49 +08:00
.vscode refactor: create workspace in one click 2020-06-26 23:56:11 +08:00
build-resources Fix menubar icon color is not set correctly on Windows & Linux (#294) 2020-06-22 23:22:11 +08:00
docs 3.9.0 2020-06-09 02:08:53 +07:00
flow-typed/npm style: install flow-types 2020-07-04 13:28:21 +08:00
patches chore: upgrade to electron v9 2020-07-13 00:17:42 +08:00
public chore: upgrade to electron v9 2020-07-13 00:17:42 +08:00
src chore: upgrade to electron v9 2020-07-13 00:17:42 +08:00
template/wiki fix: build failed on the cloud 2020-07-11 16:16:15 +08:00
.babelrc 3.6.1 2020-05-16 21:41:02 +07:00
.eslintrc feat: button to refetch repo list 2020-07-11 21:11:14 +08:00
.flowconfig feat: use github token to load repo list 2020-07-04 01:10:27 +08:00
.gitignore fix: build failed on the cloud 2020-07-11 16:16:15 +08:00
.gitmodules Shadow clone bulma submodule (#174) 2020-03-27 17:40:36 +07:00
.prettierrc style: add lots of eslint plugins 2020-06-26 19:39:23 +08:00
dist.js fix: make wiki worker work after build 2020-07-01 21:50:56 +08:00
LICENSE Initial 2019-08-30 11:41:23 +07:00
package-lock.json chore: upgrade to electron v9 2020-07-13 00:17:42 +08:00
package.json chore: upgrade to electron v9 2020-07-13 00:17:42 +08:00
README.md doc: thank atomery/singlebox 2020-06-16 18:11:59 +08:00

README.md

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.

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.

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