taon 19.0.68 → 19.0.73

package/README.md

@@ -6,70 +6,69 @@ TAON  **T**ypescript **A**ngular **O**rm **N**ode )
 
 ( ALPHA VERSION - For early testing and feedback only. )
 
-**Taon** 🔥🔥🔥 is a solution (**global cli tool** & **framework** & **cloud**) for
+**Taon** 🔥🔥🔥 is a:<br>
+1. **CLI** <br>
+2. **Framework**<br>
+3. **Cloud**<br>
+
+<br>
+for building/testing/deploying modern:<br>
+<br>
 
 \+
 [TypesScript](https://www.typescriptlang.org/) isomorphic libraries/backends/frontends
 
 \+
-[Angular](https://angular.io/) libraries and PWA-s
+[Angular](https://angular.io/) libraries and PWA apps
 
 \+ Databases with Orm ([TypeORM](https://typeorm.io/)) <br>
-- [sql.js](https://sql.js.org) - NodeJs Server Mode <br>
-- [sql.js](https://sql.js.org) - WEBSQL Server Mode (backend in browser) <br>
-- [mysql](https://www.mysql.com/) - Mysql Server Mode (inside docker) <br>
+&nbsp;- [sql.js](https://sql.js.org)<br>
+&nbsp;&nbsp;&nbsp;->  local development mode<br>
+&nbsp;&nbsp;&nbsp;->  local development with backend in browser mode (WEBSQL) <br>
+&nbsp;&nbsp;&nbsp;->  production dockerized mode <br>
+&nbsp;&nbsp;&nbsp;->  production backend in browser mode (WEBSQL) <br>
+&nbsp;- [mysql](https://www.mysql.com/)  
+&nbsp;&nbsp;&nbsp;-> production dockerized mode (NOT READY YET) <br>
 
 \+
-[NodeJS](https://nodejs.org/en/) backends
-
+[NodeJS](https://nodejs.org/en/) backends deployable on any server with on command
+  
 \+
 [Electron](https://www.electronjs.org/) desktop apps
 
 \+
-[Ionic](https://www.electronjs.org/) mobile apps
+[Ionic](https://www.electronjs.org/) mobile apps (NOT READY YET)
 
 \+
 [Visual Studio Code](https://www.electronjs.org/) plugins
 
-\+ Documentation:<br>
+\+ Documentation websites with:<br>
 - [MkDocs](https://www.mkdocs.org/) beautifull material wrapper for *.md docs files <br>
-- [Storybook](https://storybook.js.org/docs/get-started/angular) ui elements documentation <br>
-- [Compodoc](https://compodoc.app/) docs from comments <br>
- 
-backend/frontend **[*isomorphic](https://en.wikipedia.org/wiki/Isomorphic_JavaScript)**  apps/libs.
+- [Storybook](https://storybook.js.org/docs/get-started/angular) ui elements documentation (NOT READY YET)<br>
+- [Compodoc](https://compodoc.app/) docs from comments (NOT READY YET) <br>
+
+
 
 **[READ DOCUMENTATION](https://taon.dev/#/docs)**
 
 ### Initial requirements of taon
 1. Installed git 
- (on windows only supported [gitbash](https://gitforwindows.org) or [new powershell pwsh](https://github.com/PowerShell/PowerShell))
+ (on windows only supported [gitbash](https://gitforwindows.org) or [pwsh](https://github.com/PowerShell/PowerShell))
 
 2. Increased watchers limit (only on linux):
 ```bash
 echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
 ```
-3. Installed [python3](https://www.python.org/downloads/release/python-3123/) 
-and [mkdocs](https://www.mkdocs.org/user-guide/installation/):<br>
 
-Windwos/Linux
-```bash
-pip3 install mkdocs
-pip3 install mkdocs-material --user
-```
-MacOs
-```bash
-brew install mkdocs
-brew install mkdocs-material
-```
 
 ## Supported OS-es:
-- Win10, Win11 (gitbash)
-- MacOS
+- Win10, Win11 (gitbash, pwsh)
+- MacOS 
 - Linux
 
 
 ## Required version of NodeJS
-- Windows 10/11 (gitbash,pwsh): >= v18
+- Windows 10/11 >= v18
 - MacOS: >= v18
 - Linux: >= v18
 
@@ -86,7 +85,7 @@ that are being shared across all taon projects.
 
 ```bash
 npm uninstall -g taon
-rm -rf ~/.taon  # taon local packages repository
+rm -rf ~/.taon  # taon local repositories, databases, settings, caches.
 ```
 
 
@@ -97,14 +96,10 @@ rm -rf ~/.taon  # taon local packages repository
     + main cli / code structuring tool
 - taon-core https://github.com/darekf77/tnp-core
     + essential/core helpers for all projects
-- taon-class-helpers https://github.com/darekf77/typescript-class-helpers
-    + helpers for OOP class names based
-- taon-config https://github.com/darekf77/tnp-config
-    + config/models for general purpose
-- taon-cli https://github.com/darekf77/tnp-cli
-    + helpers/abstraction for global cli tools NodeJS based
 - taon-helpers https://github.com/darekf77/tnp-helpers
     + extended core helpers
+- taon-rest https://github.com/darekf77/ng2-rest
+    + easy rest api
 - taon-json https://github.com/darekf77/json10
     + handle JSON in better way
 - taon-logger https://github.com/darekf77/ng2-logger
@@ -113,25 +108,20 @@ rm -rf ~/.taon  # taon local packages repository
     + TypeOrm fork 
 - taon-type-sql https://github.com/darekf77/taon-type-sql
     + strongly type sql
-- taon-rest https://github.com/darekf77/ng2-rest
-    + easy rest api
 - taon-incremental-watcher https://github.com/darekf77/incremental-compiler
     + abstraction for incremental builders NodeJS based 
 - taon-storage https://github.com/darekf77/taon-storage
     + ts decorators based storage solution
 - taon-walk-object https://github.com/darekf77/lodash-walk-object
     + iterate over deep properties in object
-
+- taon-class-helpers https://github.com/darekf77/typescript-class-helpers
+    + helpers for OOP class names based
 
 
 ## Global npm dependencies installed with taon 
 Installation happens when you first time use taon
 ```jsonc
 [
-  // zip extractor.. no needed anymore (WILL BE REMOVED SOON FROM GLOBAL DEPSS)
-  { name: 'extract-zip', version: '1.6.7' },  
-  // check version of your nodejs
-  { name: 'check-node-version' },
   // alternative not npx ( it wil not download package from npm if is not installed )
   { name: 'npm-run', version: '4.1.2' },
   //handy for removing files
@@ -152,7 +142,7 @@ Installation happens when you first time use taon
   { name: 'jest' },
   // run ts like js
   { name: 'ts-node' },
-  // oficial vsce package striped out from some restrictions
+  // fork of vsce package without npm dependencies restrictions
   { name: 'taon-vsce' },
   // analyze you final bundle
   { name: 'webpack-bundle-analyzer' }