taon 19.0.72 → 19.0.75

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,158 +1,150 @@
1
- <p style="text-align: center;"><img src="./images/logo-header-bold-taon.png" ></p>
2
-
3
- <!-- cspell: disable-next-line -->
4
- TAON **T**ypescript **A**ngular **O**rm **N**ode )
5
-
6
-
7
- ( ALPHA VERSION - For early testing and feedback only. )
8
-
9
- **Taon** 🔥🔥🔥 is a solution (**global cli tool** & **framework** & **cloud**) for
10
-
11
- \+
12
- [TypesScript](https://www.typescriptlang.org/) isomorphic libraries/backends/frontends
13
-
14
- \+
15
- [Angular](https://angular.io/) libraries and PWA-s
16
-
17
- \+ Databases with Orm ([TypeORM](https://typeorm.io/)) <br>
18
- - [sql.js](https://sql.js.org) - NodeJs Server Mode <br>
19
- - [sql.js](https://sql.js.org) - WEBSQL Server Mode (backend in browser) <br>
20
- - [mysql](https://www.mysql.com/) - Mysql Server Mode (inside docker) <br>
21
-
22
- \+
23
- [NodeJS](https://nodejs.org/en/) backends
24
-
25
- \+
26
- [Electron](https://www.electronjs.org/) desktop apps
27
-
28
- \+
29
- [Ionic](https://www.electronjs.org/) mobile apps
30
-
31
- \+
32
- [Visual Studio Code](https://www.electronjs.org/) plugins
33
-
34
- \+ Documentation:<br>
35
- - [MkDocs](https://www.mkdocs.org/) beautifull material wrapper for *.md docs files <br>
36
- - [Storybook](https://storybook.js.org/docs/get-started/angular) ui elements documentation <br>
37
- - [Compodoc](https://compodoc.app/) docs from comments <br>
38
-
39
- backend/frontend **[*isomorphic](https://en.wikipedia.org/wiki/Isomorphic_JavaScript)** apps/libs.
40
-
41
- **[READ DOCUMENTATION](https://taon.dev/#/docs)**
42
-
43
- ### Initial requirements of taon
44
- 1. Installed git
45
- (on windows only supported [gitbash](https://gitforwindows.org) or [new powershell pwsh](https://github.com/PowerShell/PowerShell))
46
-
47
- 2. Increased watchers limit (only on linux):
48
- ```bash
49
- echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
50
- ```
51
- 3. Installed [python3](https://www.python.org/downloads/release/python-3123/)
52
- and [mkdocs](https://www.mkdocs.org/user-guide/installation/):<br>
53
-
54
- Windwos/Linux
55
- ```bash
56
- pip3 install mkdocs
57
- pip3 install mkdocs-material --user
58
- ```
59
- MacOs
60
- ```bash
61
- brew install mkdocs
62
- brew install mkdocs-material
63
- ```
64
-
65
- ## Supported OS-es:
66
- - Win10, Win11 (gitbash)
67
- - MacOS
68
- - Linux
69
-
70
-
71
- ## Required version of NodeJS
72
- - Windows 10/11 (gitbash,pwsh): >= v18
73
- - MacOS: >= v18
74
- - Linux: >= v18
75
-
76
-
77
- ## How to install taon
78
- ```
79
- npm i -g taon
80
- ```
81
-
82
-
83
- ## How to uninstall taon from local machine
84
- Taon stores a big global container (in ~/.taon) for npm packages <br>
85
- that are being shared across all taon projects.
86
-
87
- ```bash
88
- npm uninstall -g taon
89
- rm -rf ~/.taon # taon local packages repository
90
- ```
91
-
92
-
93
- ## Projects that are part of taon.dev:
94
- - taon https://github.com/darekf77/taon
95
- + framework library
96
- - tnp https://github.com/darekf77/tnp
97
- + main cli / code structuring tool
98
- - taon-core https://github.com/darekf77/tnp-core
99
- + essential/core helpers for all projects
100
- - taon-class-helpers https://github.com/darekf77/typescript-class-helpers
101
- + helpers for OOP class names based
102
- - taon-cli https://github.com/darekf77/tnp-cli
103
- + helpers/abstraction for global cli tools NodeJS based
104
- - taon-helpers https://github.com/darekf77/tnp-helpers
105
- + extended core helpers
106
- - taon-json https://github.com/darekf77/json10
107
- + handle JSON in better way
108
- - taon-logger https://github.com/darekf77/ng2-logger
109
- + logging in isomorphic apps
110
- - taon-typeorm https://github.com/darekf77/taon-typeorm
111
- + TypeOrm fork
112
- - taon-type-sql https://github.com/darekf77/taon-type-sql
113
- + strongly type sql
114
- - taon-rest https://github.com/darekf77/ng2-rest
115
- + easy rest api
116
- - taon-incremental-watcher https://github.com/darekf77/incremental-compiler
117
- + abstraction for incremental builders NodeJS based
118
- - taon-storage https://github.com/darekf77/taon-storage
119
- + ts decorators based storage solution
120
- - taon-walk-object https://github.com/darekf77/lodash-walk-object
121
- + iterate over deep properties in object
122
-
123
-
124
-
125
- ## Global npm dependencies installed with taon
126
- Installation happens when you first time use taon
127
- ```jsonc
128
- [
129
- // zip extractor.. no needed anymore (WILL BE REMOVED SOON FROM GLOBAL DEPSS)
130
- { name: 'extract-zip', version: '1.6.7' },
131
- // check version of your nodejs
132
- { name: 'check-node-version' },
133
- // alternative not npx ( it wil not download package from npm if is not installed )
134
- { name: 'npm-run', version: '4.1.2' },
135
- //handy for removing files
136
- { name: 'rimraf', version: '3.0.2' },
137
- //handy for recreating catalogs
138
- { name: 'mkdirp' },
139
- // package manager
140
- { name: 'yarn' },
141
- // https server with --base-href
142
- { name: 'taon-http-server' },
143
- // code formatter
144
- { name: 'prettier' },
145
- // process killer
146
- { name: 'fkill', installName: 'fkill-cli' },
147
- // for unit tests runner
148
- { name: 'mocha' },
149
- // for unit tests runner
150
- { name: 'jest' },
151
- // run ts like js
152
- { name: 'ts-node' },
153
- // oficial vsce package striped out from some restrictions
154
- { name: 'taon-vsce' },
155
- // analyze you final bundle
156
- { name: 'webpack-bundle-analyzer' }
157
- ]
158
- ```
1
+ <p style="text-align: center;"><img src="./images/logo-header-bold-taon.png" ></p>
2
+
3
+ <!-- cspell: disable-next-line -->
4
+ TAON **T**ypescript **A**ngular **O**rm **N**ode )
5
+
6
+
7
+ ( ALPHA VERSION - For early testing and feedback only. )
8
+
9
+ **Taon** 🔥🔥🔥 is a:<br>
10
+ 1. **CLI** <br>
11
+ 2. **Framework**<br>
12
+ 3. **Cloud**<br>
13
+
14
+ <br>
15
+ for building/testing/deploying modern:<br>
16
+ <br>
17
+
18
+ \+
19
+ [TypesScript](https://www.typescriptlang.org/) isomorphic libraries/backends/frontends
20
+
21
+ \+
22
+ [Angular](https://angular.io/) libraries and PWA apps
23
+
24
+ \+ Databases with Orm ([TypeORM](https://typeorm.io/)) <br>
25
+ &nbsp;- [sql.js](https://sql.js.org)<br>
26
+ &nbsp;&nbsp;&nbsp;-> local development mode<br>
27
+ &nbsp;&nbsp;&nbsp;-> local development with backend in browser mode (WEBSQL) <br>
28
+ &nbsp;&nbsp;&nbsp;-> production dockerized mode <br>
29
+ &nbsp;&nbsp;&nbsp;-> production backend in browser mode (WEBSQL) <br>
30
+ &nbsp;- [mysql](https://www.mysql.com/)
31
+ &nbsp;&nbsp;&nbsp;-> production dockerized mode (NOT READY YET) <br>
32
+
33
+ \+
34
+ [NodeJS](https://nodejs.org/en/) backends deployable on any server with on command
35
+
36
+ \+
37
+ [Electron](https://www.electronjs.org/) desktop apps
38
+
39
+ \+
40
+ [Ionic](https://www.electronjs.org/) mobile apps (NOT READY YET)
41
+
42
+ \+
43
+ [Visual Studio Code](https://www.electronjs.org/) plugins
44
+
45
+ \+ Documentation websites with:<br>
46
+ - [MkDocs](https://www.mkdocs.org/) beautifull material wrapper for *.md docs files <br>
47
+ - [Storybook](https://storybook.js.org/docs/get-started/angular) ui elements documentation (NOT READY YET)<br>
48
+ - [Compodoc](https://compodoc.app/) docs from comments (NOT READY YET) <br>
49
+
50
+
51
+
52
+ **[READ DOCUMENTATION](https://taon.dev/#/docs)**
53
+
54
+ ### Initial requirements of taon
55
+ 1. Installed git
56
+ (on windows only supported [gitbash](https://gitforwindows.org) or [pwsh](https://github.com/PowerShell/PowerShell))
57
+
58
+ 2. Increased watchers limit (only on linux):
59
+ ```bash
60
+ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
61
+ ```
62
+
63
+
64
+ ## Supported OS-es:
65
+ - Win10, Win11 (gitbash, pwsh)
66
+ - MacOS
67
+ - Linux
68
+
69
+
70
+ ## Required version of NodeJS
71
+ - Windows 10/11 >= v18
72
+ - MacOS: >= v18
73
+ - Linux: >= v18
74
+
75
+
76
+ ## How to install taon
77
+ ```
78
+ npm i -g taon
79
+ ```
80
+
81
+
82
+ ## How to uninstall taon from local machine
83
+ Taon stores a big global container (in ~/.taon) for npm packages <br>
84
+ that are being shared across all taon projects.
85
+
86
+ ```bash
87
+ npm uninstall -g taon
88
+ rm -rf ~/.taon # taon local repositories, databases, settings, caches.
89
+ ```
90
+
91
+
92
+ ## Projects that are part of taon.dev:
93
+ - taon https://github.com/darekf77/taon
94
+ + framework library
95
+ - tnp https://github.com/darekf77/tnp
96
+ + main cli / code structuring tool
97
+ - taon-core https://github.com/darekf77/tnp-core
98
+ + essential/core helpers for all projects
99
+ - taon-helpers https://github.com/darekf77/tnp-helpers
100
+ + extended core helpers
101
+ - taon-rest https://github.com/darekf77/ng2-rest
102
+ + easy rest api
103
+ - taon-json https://github.com/darekf77/json10
104
+ + handle JSON in better way
105
+ - taon-logger https://github.com/darekf77/ng2-logger
106
+ + logging in isomorphic apps
107
+ - taon-typeorm https://github.com/darekf77/taon-typeorm
108
+ + TypeOrm fork
109
+ - taon-type-sql https://github.com/darekf77/taon-type-sql
110
+ + strongly type sql
111
+ - taon-incremental-watcher https://github.com/darekf77/incremental-compiler
112
+ + abstraction for incremental builders NodeJS based
113
+ - taon-storage https://github.com/darekf77/taon-storage
114
+ + ts decorators based storage solution
115
+ - taon-walk-object https://github.com/darekf77/lodash-walk-object
116
+ + iterate over deep properties in object
117
+ - taon-class-helpers https://github.com/darekf77/typescript-class-helpers
118
+ + helpers for OOP class names based
119
+
120
+
121
+ ## Global npm dependencies installed with taon
122
+ Installation happens when you first time use taon
123
+ ```jsonc
124
+ [
125
+ // alternative not npx ( it wil not download package from npm if is not installed )
126
+ { name: 'npm-run', version: '4.1.2' },
127
+ //handy for removing files
128
+ { name: 'rimraf', version: '3.0.2' },
129
+ //handy for recreating catalogs
130
+ { name: 'mkdirp' },
131
+ // package manager
132
+ { name: 'yarn' },
133
+ // https server with --base-href
134
+ { name: 'taon-http-server' },
135
+ // code formatter
136
+ { name: 'prettier' },
137
+ // process killer
138
+ { name: 'fkill', installName: 'fkill-cli' },
139
+ // for unit tests runner
140
+ { name: 'mocha' },
141
+ // for unit tests runner
142
+ { name: 'jest' },
143
+ // run ts like js
144
+ { name: 'ts-node' },
145
+ // fork of vsce package without npm dependencies restrictions
146
+ { name: 'taon-vsce' },
147
+ // analyze you final bundle
148
+ { name: 'webpack-bundle-analyzer' }
149
+ ]
150
+ ```