JANE/README.md

# JANE

Just another note editor written in VUE.js for learning purposes.

## Description

To get a better understanding of the VUE.js framework, I wanted to create a tool for my personal usage.
I am a big fan of the apple notes app, sadly there is no linux port, therefore I started this project not to create such port,
but to have a portfolio application to learn more about typescript and VUE.js and to have an excuse why I have to use Vite for a project.

## License

This Project is based on a YouTube Video by Tylor Potts (https://www.youtube.com/watch?v=YwUvSa9Ckqo) and therfore I am releasing this code under the GPL 3 license.

## Versions

- Version 1.0.2 - introducing markdown rendering (did you saw the easter egg??). Minor refactoring and rework of the readme
- Version 1.0.1 - basic CRUD for notes, persitancy with browser based localstorage. Minor refactoring and rework of the readme
- Version 1.0.0 - with the basic setup to creating, deleting and editing new notes. There is no persistent storage a reload deletes all notes.

## Coming next

* [x] script to compress the release
* [ ] script to upload the release
* [ ] (s)ftp based deployment
* [ ] runner based release pipeline
* [ ] release note generator based on the commits
* [ ] better UI
* [ ] better Icons
* [x] markdown rendering
* [ ] link rendering
* [ ] code rendering
* [ ] emoji rendering
* [x] persistent storage based on something like local storage of the browser
* [ ] persistent storage based on backend api (can be edited by the user)
* [ ] PWA Setup so that the "app" can be installed on the users system
* [ ] Website to inform the user about and give the user an entry point for JANE

## Possible Ideas

* [ ] persistent storage service?
* [ ] login service?