seokju-na / geeks-diary

TIL writing tool for programmer

Geek's Diary

Geek's Diary is markdown editor with version control system integrated. It helps programmers to write TIL(Today I Learned).

🚀 Beta releases

You can download the installer from Github Releases.

Currently, only macOS is supported. The official version (v1.0.0) will also support Windows.

AutoUpdater is omitted from beta release. When a new version is released, you will need to update it manually.

Features

Mix markdown with code

A note in Geek's Diary is comprised of snippets (markdown, code). You can freely mix different snippet types within one note.

Categorize your note with development stack

Geek's Diary is for programmers. You can categorize your note with numerous development stacks (from konpa/devicon).

Contribute measurement

Geek's Diary measures contribution with commit counts in a day. You can look your contribution level with grass UI in calendar. Similar with github!

Version Control System integrated

Control your version with powerful VCS -- We currently supports git. Geek's Diary tracks your file changes from workspace, and you can committed it.

Sync with remote repository

Thanks to the integration of the version control system, you can sync your workspace with remote repository. Log in to github and sync your TILs.

Plan

These are v1.0.0 features.

• Auto Updater #124
• Release win32 platform
• Performance issue for note editor #113
• Migrate from existing TIL repository #120

Development

Requirements

• node.js@~8.12 https://nodejs.org/en/download/
• yarn@>=1.9 https://yarnpkg.com/en/docs/install

Project setup

Fork the project on GitHub and clone your fork locally.

git clone [email protected]:username/geeks-diary.git
cd geeks-diary

git remote add upstream https://github.com/seokju-na/geeks-diary.git
git fetch upstream

yarn install

Starting

yarn serve:browser:app
yarn serve:browser:wizard
yarn serve:main-process

// After build completed.

yarn start

Test

yarn test

Contributing

❤️ Thanks for your interest!

If you have suggestions for how this project could be improved, or want to report a bug, open an issue! We'd love all and any contributions. If you have questions, too, we'd love to hear them.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License

MIT Licensed

geeks-diary's Issues

Base vcs redux center (state / actions / reducer)

See more information via #61

Add images supported

• Insert image by Drag & Drop in text snippet (Skip in this moment. Move to next plan)
• Insert image in text snippet: Alt + Shift + I

Integrate note with vcs file change

We need to know whether note is changed.

Add vcs feature

UI Sketch

Module Architecting (WIP)

Nov 5, 2018

Todos

UI

• Tab #62
• Checkbox #63
• Expansion #64
• Menu #77 (Included)

VCS

• VcsRemoteService -> VcsService #66
• Base vcs redux center (state / actions / reducer) #68
• Design algorithm for vcs item making factory. #71
• Vcs list UI interaction. (Maybe I will do it later)
• Vcs redux center. Including effects. #75
• Commit dialog #78
• History #86
• Sync with remote (pull/push) #90

Notes

• Add note vcs item. #79

Vcs redux center. Including effects.

References: #61

Vcs history tab

See #61

VcsCommitModule -> VcsLocalModule

Add view note information feature

Image URL broken when note has label

Image URL should be relative with root directory.

Commit dialog

Make commit dialog.
References to #61

Add note sort order feature

Completed in #28

Sync scroll between editor and preview

Design algorithm for vcs item making factory

References #61

Make commit note feature

Editor view mode

Add note snippet editor history undo/redo implement

Maybe... Some future...

Vcs list UI interaction.

Overview

List UI interaction considered aria.

Feature

References

• Github Desktop list component. desktop/desktop

Stack input in note

Add note vcs item

References #61

Minify renderer bundle on aot mode

UglifyJS has issue for es6.

Un-matched height of text snippet editor

Caused from:

• Text snippet editor (based on CodeMirror) has 'lineWrapping' option.
• Snippet container has 'flex' style to calculate width size.

Refactor suggestions:

• Update editor size after layout changed.
• See references:
  • cm.refresh() Method
  • CodeMirror auto-refresh addon https://codemirror.net/doc/manual.html#addon_autorefresh

Add simple e2e test

Add context-menu on note item

Read contextmenu from MDN.

Add note contribution table

Sync with remote (pull/push)

See #61

VcsRemoteService -> VcsService

References #61

User data module

Recovering

Chips UI

Add note collection feature

Update angular version to 6

References blog article, Upgrading a project without CLI to Angular 6

Wizard feature for initializing workspace

Unexpected file change

Remove 'updatedDatetime' from note model to prevent file change detection even if content is same with before the changes.

Add vcs manager

Add code coverage and codecov extension

Add note snippet editor

View first note when navigate note calendar

Add global keyboard shortcut

For macOS build only at v1.0
(Windows will be supported next release)

Add note empty state view

Add stack language filter

Inserting new snippet

• Should insert code snippet after current focused snippet when press Cmd/Ctrl + Shift + C
• Should insert text snippet after current focused snippet when press Cmd/Ctrl + Shift + T
• Should insert same snippet after current focused snippet when press Shift + Return/Enter(TODO)

Add settings

AppModule consumes settings.

Note title input feature

I WANT TO CHANGE NOTE TITLE

Empty state for vcs changes, history tab.

Add note delete feature

Add git workspace initialization process

• Will use nodegit
• Required node-gyp rebuild for electron support.

Update 'NoteEditorCodeSnippet' setting form layout

MORE FENCY!

Add custom scrollbar

Native scrollbar is ugly.
Make custom scrollbar.

Add user date store. Apply last opened note, last modified editor view mode, etc.

Ignore scrolling event when all history items are loaded

geeks-diary/src/browser/vcs/vcs-manager.component.ts

Line 95 in e69cb16

filter(() => !this.commitItemsAreLoading),

Add flags to ignore