https://github.com/seokju-na/geeks-diary
TIL writing tool for programmer
https://github.com/seokju-na/geeks-diary
angular diary electron electron-app geeks-diary javascript learning note til typescript
Last synced: about 1 year ago
JSON representation
TIL writing tool for programmer
- Host: GitHub
- URL: https://github.com/seokju-na/geeks-diary
- Owner: seokju-na
- License: mit
- Archived: true
- Created: 2017-05-17T09:39:32.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T05:56:59.000Z (over 4 years ago)
- Last Synced: 2024-10-31T23:31:04.786Z (over 1 year ago)
- Topics: angular, diary, electron, electron-app, geeks-diary, javascript, learning, note, til, typescript
- Language: TypeScript
- Homepage:
- Size: 7.93 MB
- Stars: 695
- Watchers: 19
- Forks: 85
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - geeks-diary - na | 642 | (TypeScript)
README
# Geek's Diary
[](https://travis-ci.org/seokju-na/geeks-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](https://github.com/seokju-na/geeks-diary/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](https://github.com/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/](https://nodejs.org/en/download/)
- yarn@>=1.9 [https://yarnpkg.com/en/docs/install](https://yarnpkg.com/en/docs/install)
### Project setup
Fork the project [on GitHub](https://github.com/seokju-na/geeks-diary) and clone your fork locally.
```bash
git clone git@github.com: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
```bash
yarn serve:browser:app
yarn serve:browser:wizard
yarn serve:main-process
// After build completed.
yarn start
```
### Test
```bash
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](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
## License
MIT Licensed