Konnote is an application that helps you relate all the notes that you take down by tagging each note, and relating it to other notes with similar tags.
I love to take notes on everything, all the time! When it came time to using those notes, I had to search the different sites and files I had saved my notes on (Assuming that I find all of them, of course). So this tool is what I used to save my notes, then relate all topics e.g best practices, code smells, setup script, documentation, tricks etc.
First, clone the repository.
$ git clone https://github.com/jmgutu/konnote.gitCreate a virtual environment in a directory of your choosing. Use python 3.7 or python 3.8.
$ python -m venv <name_of_virtual_env>Activate the virtual environment
$ source <name_of_virtual_env>/bin/activateThe name of the environment should appear on the leftmost of the prompt.
(<name_of_virtual_env>) $ source <name_of_virtual_env>/bin/activateNavigate into konnote.
(<name_of_virtual_env>) $ cd konnoteInstall the requirements into the newly created virtual environment.
(<name_of_virtual_env>) $ pip install wheel
(<name_of_virtual_env>) $ pip install -r requirements.txtAfter the packages have been installed, you need migrate.
(<name_of_virtual_env>) $ python manage.py migrateOnce the migrations have been done, create a superuser.
(<name_of_virtual_env>) $ python manage.py createsuperuserAfter successful creation of the super user, run the application.
(<name_of_virtual_env>) $ python manage.py runserver Subject
└── Chapter
└── Topic
└── Post
| Entity | Definition |
|---|---|
| Subject | The name of a discipline or language. A noun. |
| Chapter | A collection of similar topics within the same subject. |
| Topic | The smallest unit a Subject can be broken down into. |
| Post | Text, Video, Image or URL that is to be saved. |
| Post Type | Either Image, Video or Text |
| Tag | A Word or short phrase that can be used to describe a post. E.g django, models, fields, format etc |
| Post Resource | A resource allocated to a Post. |
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.