refactor(build): rename vanilla example web demo folder

ghiscoding · Mar 30, 2020 · 29c9d89 · 29c9d89
1 parent 31de551
commit 29c9d89
Show file tree

Hide file tree

Showing 31 changed files with 19 additions and 10 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -16,7 +16,7 @@
       "sourceMapPathOverrides": {
         "webpack:///../common/*": "${webRoot}/packages/common/*",
         "webpack:///../vanilla-bundle/*": "${webRoot}/packages/vanilla-bundle/*",
-        "webpack:///./src/*": "${webRoot}/packages/vanilla-bundle-examples/src/*"
+        "webpack:///./src/*": "${webRoot}/packages/web-demo-vanilla-bundle/src/*"
       }
     },
     {
@@ -38,4 +38,4 @@
       }
     }
   ]
-}
+}
diff --git a/README.md b/README.md
@@ -7,7 +7,11 @@
 [![codecov](https://codecov.io/gh/ghiscoding/slickgrid-universal/branch/master/graph/badge.svg)](https://codecov.io/gh/ghiscoding/slickgrid-universal)
 [![jest](https://jestjs.io/img/jest-badge.svg)](https://github.com/facebook/jest)
 
-This is a monorepo project (using Lerna) which is regrouping a few packages under a single repository. The goal is to create a common repo that includes all Editors, Filters, Extensions and Services that could be used by any Framework (it is framework agnostic). It's also a good opportunity to decouple some other features/services that not every user require, this will also help in getting a smaller bundle size. For example, not many users require backend services (OData, GraphQL), which is why they are better handled in a monorepo structure.
+This is a monorepo project (using Lerna) which is regrouping a few packages under a single repository. The goal is to create a common repo that includes all Editors, Filters, Extensions and Services that could be used by any Framework (it is framework agnostic). It's also a good opportunity to decouple some features/services that not every project require at all time, this will also help in getting a smaller bundle size. For example, not every project require backend services (OData, GraphQL), which is why they are better handled in a monorepo structure.
+
+### Demo page
+The GitHub [demo page](https://ghiscoding.github.io/slickgrid-universal) uses the Material Design theme but you could also use `Bootstrap 3` and/or `Bootstrap 4` theme which is demoed in other frameworks. 
+- [Web-Demo-Vanilla-Bundle](https://ghiscoding.github.io/slickgrid-universal) with Material Design theme
 
 ### Why create this monorepo?
 You might be wondering why was this monorepo created?
@@ -18,30 +22,35 @@ You might be wondering why was this monorepo created?
 ### Framework using this monorepo
 This is a Work in Progress, eventually [Angular-Slickgrid](https://github.com/ghiscoding/Angular-Slickgrid) and [Aurelia-Slickgrid](https://github.com/ghiscoding/aurelia-slickgrid) will be rewritten to use this monorepo which will simplify debugging/fixing common code. 
 
-However note, that this project also has a Vanilla Implementation (not associated to any framework) and that is what the UI will be tested with. The Vanilla bundle is also used in our SalesForce (with Lighning Web Component) hence the creation of this monorepo.
+Note however that this project also has a Vanilla Implementation (not associated to any framework) and that what is used to the test the UI portion. The Vanilla bundle is also used in our SalesForce (with Lighning Web Component) hence the creation of this monorepo.
 
 The main packages structure is the following
 - `@slickgrid-universal/common`: commonly used Formatters/Editors/Filters/Services/...
   - this can then be used by any Framework (Angular, Aurelia, Vanilla, ...)
 - `@slickgrid-universal/vanilla-bundle`: a vanilla TypeScript/JavaScript implementation (no framework)
-- `slickgrid-universal/vanilla-bundle-examples` standalone package for demo purposes and UI testing (not a public package)
+- 
+- Standalone Packages
+  - `slickgrid-universal/web-demo-vanilla-bundle` standalone package for demo purposes and UI testing (not a public package)
 
 ### Installation
 To get going with this monorepo, you will need to clone the repo and then follow the steps below
 
 1. Lerna Bootstrap
+
 Run it **only once**, this will install all dependencies and add necessary monorepo symlinks
 ```bash
 npm run bootstrap
 ```
 
 2. Build
-To get started you must also run (also once) an initial build so that all necessary `dist` are created for all the packages to work together.
+
+To get started you must run (also once) an initial build so that all necessary `dist` are created for all the packages to work together.
 ```bash
 npm run build
 ```
 
 3. Run Dev (Vanilla Implementation)
+
 There is a Vanilla flavor implementation of this monorepo, vanilla means that it is not associated to any framework and so it is plain TypeScript without being bound to any framework. The implementation is very similar to Angular and Aurelia, it could be used as a guideline to implement it in other frameworks.
 
 ```bash

diff --git a/packages/vanilla-bundle/README.md b/packages/vanilla-bundle/README.md
@@ -4,5 +4,5 @@
 Vanilla Bundle implementation (no framework, plain TypeSript). This does what other framework would do, it makes all the features usable in 1 bundle to be used by other Apps/Projects, for example we use this bundle in our SalesForce (with Lighning Web Component) App and it requires plain ES6 JavaScript which this bundle also produce (for that there's a `dist-grid-bundle-zip` folder which zip the ES6 `dist` folder which we import in SalesForce). 
 
 ### Installation
-This Vanilla Bundle is used by the standalone `vanilla-bundle-examples`. 
+This Vanilla Bundle is used by the standalone `web-demo-vanilla-bundle`. 
 Go to the root of the repo and follow the instruction provided in the main [README](https://github.com/ghiscoding/slickgrid-universal#installation)
diff --git a/packages/vanilla-bundle-examples/README.md → packages/web-demo-vanilla-bundle/README.md b/packages/vanilla-bundle-examples/README.md → packages/web-demo-vanilla-bundle/README.md
diff --git a/packages/vanilla-bundle-examples/index.ejs → packages/web-demo-vanilla-bundle/index.ejs b/packages/vanilla-bundle-examples/index.ejs → packages/web-demo-vanilla-bundle/index.ejs
diff --git a/...ages/vanilla-bundle-examples/package.json → ...ages/web-demo-vanilla-bundle/package.json b/...ages/vanilla-bundle-examples/package.json → ...ages/web-demo-vanilla-bundle/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "vanilla-bundle-examples",
+  "name": "web-demo-vanilla-bundle",
   "version": "0.0.2",
   "description": "SlickGrid-Universal demo",
   "directories": {
@@ -53,4 +53,4 @@
     "webpack-cli": "^3.3.11",
     "webpack-dev-server": "^3.10.3"
   }
-}
+}
diff --git a/...anilla-bundle-examples/src/app-routing.ts → ...eb-demo-vanilla-bundle/src/app-routing.ts b/...anilla-bundle-examples/src/app-routing.ts → ...eb-demo-vanilla-bundle/src/app-routing.ts
diff --git a/...ages/vanilla-bundle-examples/src/app.html → ...ages/web-demo-vanilla-bundle/src/app.html b/...ages/vanilla-bundle-examples/src/app.html → ...ages/web-demo-vanilla-bundle/src/app.html
diff --git a/packages/vanilla-bundle-examples/src/app.ts → packages/web-demo-vanilla-bundle/src/app.ts b/packages/vanilla-bundle-examples/src/app.ts → packages/web-demo-vanilla-bundle/src/app.ts
diff --git a/...ndle-examples/src/examples/example01.html → ...anilla-bundle/src/examples/example01.html b/...ndle-examples/src/examples/example01.html → ...anilla-bundle/src/examples/example01.html
diff --git a/...bundle-examples/src/examples/example01.ts → ...-vanilla-bundle/src/examples/example01.ts b/...bundle-examples/src/examples/example01.ts → ...-vanilla-bundle/src/examples/example01.ts
diff --git a/...ndle-examples/src/examples/example02.html → ...anilla-bundle/src/examples/example02.html b/...ndle-examples/src/examples/example02.html → ...anilla-bundle/src/examples/example02.html
diff --git a/...bundle-examples/src/examples/example02.ts → ...-vanilla-bundle/src/examples/example02.ts b/...bundle-examples/src/examples/example02.ts → ...-vanilla-bundle/src/examples/example02.ts
diff --git a/...ndle-examples/src/examples/example03.html → ...anilla-bundle/src/examples/example03.html b/...ndle-examples/src/examples/example03.html → ...anilla-bundle/src/examples/example03.html
diff --git a/...bundle-examples/src/examples/example03.ts → ...-vanilla-bundle/src/examples/example03.ts b/...bundle-examples/src/examples/example03.ts → ...-vanilla-bundle/src/examples/example03.ts
diff --git a/...ndle-examples/src/examples/example04.html → ...anilla-bundle/src/examples/example04.html b/...ndle-examples/src/examples/example04.html → ...anilla-bundle/src/examples/example04.html
diff --git a/...bundle-examples/src/examples/example04.ts → ...-vanilla-bundle/src/examples/example04.ts b/...bundle-examples/src/examples/example04.ts → ...-vanilla-bundle/src/examples/example04.ts
diff --git a/...ndle-examples/src/examples/example05.html → ...anilla-bundle/src/examples/example05.html b/...ndle-examples/src/examples/example05.html → ...anilla-bundle/src/examples/example05.html
diff --git a/...ndle-examples/src/examples/example05.scss → ...anilla-bundle/src/examples/example05.scss b/...ndle-examples/src/examples/example05.scss → ...anilla-bundle/src/examples/example05.scss
diff --git a/...bundle-examples/src/examples/example05.ts → ...-vanilla-bundle/src/examples/example05.ts b/...bundle-examples/src/examples/example05.ts → ...-vanilla-bundle/src/examples/example05.ts
diff --git a/...ndle-examples/src/examples/example06.html → ...anilla-bundle/src/examples/example06.html b/...ndle-examples/src/examples/example06.html → ...anilla-bundle/src/examples/example06.html
diff --git a/...ndle-examples/src/examples/example06.scss → ...anilla-bundle/src/examples/example06.scss b/...ndle-examples/src/examples/example06.scss → ...anilla-bundle/src/examples/example06.scss
diff --git a/...bundle-examples/src/examples/example06.ts → ...-vanilla-bundle/src/examples/example06.ts b/...bundle-examples/src/examples/example06.ts → ...-vanilla-bundle/src/examples/example06.ts
diff --git a/...s/vanilla-bundle-examples/src/favicon.ico → ...s/web-demo-vanilla-bundle/src/favicon.ico b/...s/vanilla-bundle-examples/src/favicon.ico → ...s/web-demo-vanilla-bundle/src/favicon.ico
diff --git a/...vanilla-bundle-examples/src/interfaces.ts → ...web-demo-vanilla-bundle/src/interfaces.ts b/...vanilla-bundle-examples/src/interfaces.ts → ...web-demo-vanilla-bundle/src/interfaces.ts
diff --git a/packages/vanilla-bundle-examples/src/main.ts → packages/web-demo-vanilla-bundle/src/main.ts b/packages/vanilla-bundle-examples/src/main.ts → packages/web-demo-vanilla-bundle/src/main.ts
diff --git a/...s/vanilla-bundle-examples/src/renderer.ts → ...s/web-demo-vanilla-bundle/src/renderer.ts b/...s/vanilla-bundle-examples/src/renderer.ts → ...s/web-demo-vanilla-bundle/src/renderer.ts
diff --git a/...s/vanilla-bundle-examples/src/styles.scss → ...s/web-demo-vanilla-bundle/src/styles.scss b/...s/vanilla-bundle-examples/src/styles.scss → ...s/web-demo-vanilla-bundle/src/styles.scss
diff --git a/...ges/vanilla-bundle-examples/tsconfig.json → ...ges/web-demo-vanilla-bundle/tsconfig.json b/...ges/vanilla-bundle-examples/tsconfig.json → ...ges/web-demo-vanilla-bundle/tsconfig.json
diff --git a/...vanilla-bundle-examples/webpack.config.js → ...web-demo-vanilla-bundle/webpack.config.js b/...vanilla-bundle-examples/webpack.config.js → ...web-demo-vanilla-bundle/webpack.config.js
diff --git a/test/jest.config.js b/test/jest.config.js
@@ -12,7 +12,7 @@ module.exports = {
     'packages/**/*.ts',
     '!**/dist/**',
     '!src/assets/**',
-    '!packages/vanilla-bundle-examples/**',
+    '!packages/web-demo-vanilla-bundle/**',
     '!**/node_modules/**',
     '!**/test/**',
   ],