|
1 |
| -<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400"></a></p> |
| 1 | +# Knowfox |
2 | 2 |
|
3 |
| -<p align="center"> |
4 |
| -<a href="https://travis-ci.org/laravel/framework"><img src="https://travis-ci.org/laravel/framework.svg" alt="Build Status"></a> |
5 |
| -<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a> |
6 |
| -<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a> |
7 |
| -<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a> |
8 |
| -</p> |
| 3 | +Knowfox is my Personal Knowledge Management system. Having been an keen Evernote user since 2012, I finally got around to taking my precious notes to my own server. |
9 | 4 |
|
10 |
| -## About Laravel |
| 5 | +[](https://gitter.im/knowfox-personal-knowledge-management/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) |
11 | 6 |
|
12 |
| -Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as: |
| 7 | +## Features |
13 | 8 |
|
14 |
| -- [Simple, fast routing engine](https://laravel.com/docs/routing). |
15 |
| -- [Powerful dependency injection container](https://laravel.com/docs/container). |
16 |
| -- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage. |
17 |
| -- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent). |
18 |
| -- Database agnostic [schema migrations](https://laravel.com/docs/migrations). |
19 |
| -- [Robust background job processing](https://laravel.com/docs/queues). |
20 |
| -- [Real-time event broadcasting](https://laravel.com/docs/broadcasting). |
| 9 | +* Hierarchies. Inspired by Dave Winer's Worldoutline and Fargo, I want my knowledge base to have a deep structure, not be only two stories tall. |
| 10 | +* Tags. Where a single hierarchy is not enough, tags can link common topics in the least intrusive way. Since the times of Web 2.0, tags are everywhere. |
| 11 | +* Typed relationships. Sometimes though, hierarchies are too strict and tags are too loose. For example, I want to link authors to books, founders to companies, cause to effect. For this, typed, bi-directional relationships are king. |
| 12 | +* Markdown. There are other many similar and nice text formats, but Markdown is simple and popular and has won the race. |
| 13 | +* Bookmarking. I frequently take note of websites and like to mark them for later reading. |
| 14 | +* Pictures. My notes have lots of pictures. Mostly screenshots, but some photos or diagrams added as well. |
| 15 | +* Privacy. All my notes and pictures are mine and should be visible to no one. |
| 16 | +* Simple journalling. I used Evernote on a daily basis and will do so with Knowfox, too. Easy, date-based journalling is a feature I use every day. |
| 17 | +* Sharing. Sometimes I want to share a note and its pictures. This should be painless and explicit. |
| 18 | +* Publishing. Knowledge wants to be communicated sometimes. For this, I want to export a sub-tree of my hierarchy as beautiful slide deck, effortlessly. |
21 | 19 |
|
22 |
| -Laravel is accessible, powerful, and provides tools required for large, robust applications. |
| 20 | +This gives me the basic structure. On top of this, |
23 | 21 |
|
24 |
| -## Learning Laravel |
| 22 | +* all my Evernote notes should go in there, |
| 23 | +* my catalogue of eBooks as well, |
| 24 | +* my timelines, too. |
25 | 25 |
|
26 |
| -Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework. |
| 26 | +The resulting system should be easy to understand, maintain and deploy. CouchDB would have been an nice option with Hoodie on to of it. Ultimately though, I felt more confident with *Laravel 5 and MySQL* so this is what Knowfox is built on. |
27 | 27 |
|
28 |
| -If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 1500 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library. |
| 28 | +## Status |
29 | 29 |
|
30 |
| -## Laravel Sponsors |
| 30 | +Knowfox is usable and very nicely so. |
31 | 31 |
|
32 |
| -We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the Laravel [Patreon page](https://patreon.com/taylorotwell). |
| 32 | +* Full text search works, maybe even better than the one in Evernote. |
| 33 | +* The integrated Markdown editor has no inline preview of images, but otherwise is a joy to use. |
| 34 | +* Picture handling is very slick, thanks to the integrated Dropzone.js and automatic inclusion of image links into the note's Markdown. |
| 35 | +* A bookmarklet helps me to bookmark websites and gather their content for later reference. |
| 36 | +* I have imported my most important Evernote notebooks and now rely on it for my everyday work and projects. |
| 37 | +* There is a hosted version at https://knowfox.com which is free to use. However, I make no guarantees as to the stability of this service. Ultimately, Knowfox is meant for self hosting. |
33 | 38 |
|
34 |
| -### Premium Partners |
| 39 | +There is a [brief presentation](https://knowfox.com/presentation/47d6c8de/013c/11e7/8a8c/56847afe9799/index.html) about the system, too. |
35 | 40 |
|
36 |
| -- **[Vehikl](https://vehikl.com/)** |
37 |
| -- **[Tighten Co.](https://tighten.co)** |
38 |
| -- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)** |
39 |
| -- **[64 Robots](https://64robots.com)** |
40 |
| -- **[Cubet Techno Labs](https://cubettech.com)** |
41 |
| -- **[Cyber-Duck](https://cyber-duck.co.uk)** |
42 |
| -- **[Many](https://www.many.co.uk)** |
43 |
| -- **[Webdock, Fast VPS Hosting](https://www.webdock.io/en)** |
44 |
| -- **[DevSquad](https://devsquad.com)** |
45 |
| -- **[Curotec](https://www.curotec.com/services/technologies/laravel/)** |
46 |
| -- **[OP.GG](https://op.gg)** |
| 41 | +In addition to what Laravel requires, Knowfox uses the following NPM modules: |
47 | 42 |
|
48 |
| -## Contributing |
| 43 | +* selectize |
| 44 | +* simplemde |
| 45 | +* dropzone |
| 46 | +* jquery-ui |
| 47 | +* jquery-resizable |
| 48 | +* featherlight |
| 49 | +* jqtree |
| 50 | +* snackbar |
| 51 | +* v-calendar |
| 52 | +* jquery |
| 53 | +* bootstrap-sass |
| 54 | +* vue |
| 55 | +* vue-template-compiler |
49 | 56 |
|
50 |
| -Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions). |
| 57 | +## The Future |
51 | 58 |
|
52 |
| -## Code of Conduct |
53 |
| - |
54 |
| -In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct). |
55 |
| - |
56 |
| -## Security Vulnerabilities |
57 |
| - |
58 |
| -If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed. |
59 |
| - |
60 |
| -## License |
61 |
| - |
62 |
| -The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT). |
| 59 | +I have built Knowfox in a frency to have a usable system as soon as possible. For others to be able to contribute, it most urgently needs automated tests. Some more importers for my other databases for eBooks and timelines will follow. Maybe native apps or a FUSE filesystem at some point. |
0 commit comments