kanji-koohii
kanji-koohii copied to clipboard
Roadmap
This roadmap focuses on refactoring & performance.
For features and improvements, see Milestones.
Refactoring (php templates + YUI 2) to VueJS
Of note here, we want to use instanced VueJS components. It's faster since they are pre-compiled, but also should make it possible to switch to the runtime only build of Vue.
Also, Kanji Koohii at this point will never be refactored to a full on SPA. The goal is not to convert 100% of the views to VueJS. The goal is to build the most important UX components from VueJS, while the basic layout can stay on the php side.
- [ ] Refactor the Flashcard Review pageto VueJS #38
- [ ] Refactor SharedStories list to VueJS #21
- [ ] Refactor the Study search auto-complete to VueJS #9
Phasing out YUI 2
- [ ] Refactor YUI 2 dependency from AjaxRequest / AjaxPanel / AjaxDialog classes
- [ ] Pick a good dialog / modal component to replace YUI 2 dialogs
- [ ] Refactor Edit Keyword / Edit Story / Edit Flashcard dialogs
Phase out "Juicer" tool
- [x] Replace Juicer of stylesheets (*.juicy.css) with SASS (scss)
Improve the build system
- [ ] upgrade to Webpack 4 for better "chunks" handling
- [ ] add ESLint to webpack
- [ ] add Prettier (but not enforce it) -- mainly for formatting CSS
- [ ] phase out *.juicy.js (Juicer) JS -- use webpack and ES6 modules?
- [x] phase out
batch/tools/yuicompressor
-- use UglifyJS & PostCSS
Javascript miscellaneous
- [ ] find a good assert() system that doesn't get compiled in the production build
- [ ] find a good way to remove all console.log / warn / error() from the production build
Docs
- [ ] Convert my docs to Gitbook or docute for contributors
Performance
- [x] Create a minimal build of Bootstrap v3 #46
- [x] Remove legacy YUI JS bundle from the Landing Page #45
- [ ] Remove legacy YUI JS bundle from ALL the pages
- [ ] Optimize FontAwesome build with just the required icons #44
I have a little suggestion about open sourcing: I have found a thread on reddit, where people can volonteer to contribute to open source project. Every weekend they receive a newsletter with the list of the projects, So if you feel like trying, you could suggest kanji-koohii as a project; some peole should be able to help.
Thank you Erlemar. That is an interesting option I didn't think about.