slicejs-web-framework 3.2.1 → 3.2.3
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/.opencode/opencode.json +14 -0
- package/LICENSE +21 -21
- package/README.md +174 -174
- package/Slice/Components/Structural/ContextManager/ContextManager.js +369 -369
- package/Slice/Components/Structural/ContextManager/ContextManagerDebugger.js +297 -297
- package/Slice/Components/Structural/Controller/Controller.js +1138 -1129
- package/Slice/Components/Structural/Controller/allowedValuesValidation.js +52 -0
- package/Slice/Components/Structural/Debugger/Debugger.css +619 -619
- package/Slice/Components/Structural/Debugger/Debugger.html +72 -72
- package/Slice/Components/Structural/Debugger/Debugger.js +1547 -1547
- package/Slice/Components/Structural/EventManager/EventManager.js +338 -338
- package/Slice/Components/Structural/EventManager/EventManagerDebugger.js +361 -361
- package/Slice/Components/Structural/Logger/Log.js +10 -10
- package/Slice/Components/Structural/Logger/Logger.js +146 -146
- package/Slice/Components/Structural/Router/Router.js +721 -721
- package/Slice/Components/Structural/StylesManager/StylesManager.js +78 -78
- package/Slice/Components/Structural/StylesManager/ThemeManager/ThemeManager.js +84 -84
- package/Slice/Slice.js +542 -542
- package/Slice/tests/build-bundled-component-without-category.test.js +103 -103
- package/Slice/tests/build-js-only-visual-components.test.js +144 -144
- package/Slice/tests/bundle-v2-runtime-contract.test.js +728 -728
- package/Slice/tests/props-allowed-values-validation.test.js +119 -0
- package/Slice/tests/public-env-runtime-accessors.test.js +44 -44
- package/Slice/tests/router-loading-finally.test.js +68 -68
- package/api/index.js +286 -286
- package/api/middleware/securityMiddleware.js +252 -252
- package/api/tests/public-env-resolver.test.js +193 -193
- package/api/utils/publicEnvResolver.js +117 -117
- package/package.json +38 -37
- package/sliceConfig.schema.json +109 -109
- package/src/App/index.html +22 -22
- package/src/App/index.js +23 -23
- package/src/App/style.css +40 -40
- package/src/Components/AppComponents/HomePage/HomePage.css +201 -201
- package/src/Components/AppComponents/HomePage/HomePage.html +37 -37
- package/src/Components/AppComponents/HomePage/HomePage.js +210 -210
- package/src/Components/AppComponents/Playground/Playground.css +11 -11
- package/src/Components/AppComponents/Playground/Playground.js +111 -111
- package/src/Components/Service/FetchManager/FetchManager.js +133 -133
- package/src/Components/Service/IndexedDbManager/IndexedDbManager.js +141 -141
- package/src/Components/Service/LocalStorageManager/LocalStorageManager.js +45 -45
- package/src/Components/Visual/Button/Button.css +47 -47
- package/src/Components/Visual/Button/Button.html +5 -5
- package/src/Components/Visual/Button/Button.js +92 -92
- package/src/Components/Visual/Card/Card.css +68 -68
- package/src/Components/Visual/Card/Card.html +7 -7
- package/src/Components/Visual/Card/Card.js +107 -107
- package/src/Components/Visual/Checkbox/Checkbox.css +87 -87
- package/src/Components/Visual/Checkbox/Checkbox.html +8 -8
- package/src/Components/Visual/Checkbox/Checkbox.js +86 -86
- package/src/Components/Visual/CodeVisualizer/CodeVisualizer.css +129 -129
- package/src/Components/Visual/CodeVisualizer/CodeVisualizer.html +3 -3
- package/src/Components/Visual/CodeVisualizer/CodeVisualizer.js +262 -262
- package/src/Components/Visual/Details/Details.css +70 -70
- package/src/Components/Visual/Details/Details.html +9 -9
- package/src/Components/Visual/Details/Details.js +76 -76
- package/src/Components/Visual/DropDown/DropDown.css +60 -60
- package/src/Components/Visual/DropDown/DropDown.html +5 -5
- package/src/Components/Visual/DropDown/DropDown.js +63 -63
- package/src/Components/Visual/Grid/Grid.css +7 -7
- package/src/Components/Visual/Grid/Grid.html +1 -1
- package/src/Components/Visual/Grid/Grid.js +57 -57
- package/src/Components/Visual/Icon/Icon.css +510 -510
- package/src/Components/Visual/Icon/Icon.js +89 -89
- package/src/Components/Visual/Icon/slc.json +554 -554
- package/src/Components/Visual/Icon/slc.styl +507 -507
- package/src/Components/Visual/Icon/slc.svg +1485 -1485
- package/src/Components/Visual/Icon/slc.symbol.svg +1058 -1058
- package/src/Components/Visual/Input/Input.css +91 -91
- package/src/Components/Visual/Input/Input.html +4 -4
- package/src/Components/Visual/Input/Input.js +215 -215
- package/src/Components/Visual/Layout/Layout.js +49 -49
- package/src/Components/Visual/Link/Link.css +8 -8
- package/src/Components/Visual/Link/Link.html +1 -1
- package/src/Components/Visual/Link/Link.js +63 -63
- package/src/Components/Visual/Loading/Loading.css +56 -56
- package/src/Components/Visual/Loading/Loading.html +83 -83
- package/src/Components/Visual/Loading/Loading.js +38 -38
- package/src/Components/Visual/MultiRoute/MultiRoute.js +93 -93
- package/src/Components/Visual/Navbar/Navbar.css +115 -115
- package/src/Components/Visual/Navbar/Navbar.html +44 -44
- package/src/Components/Visual/Navbar/Navbar.js +141 -141
- package/src/Components/Visual/NotFound/NotFound.css +116 -116
- package/src/Components/Visual/NotFound/NotFound.html +23 -23
- package/src/Components/Visual/NotFound/NotFound.js +16 -16
- package/src/Components/Visual/Route/Route.js +93 -93
- package/src/Components/Visual/Select/Select.css +84 -84
- package/src/Components/Visual/Select/Select.html +8 -8
- package/src/Components/Visual/Select/Select.js +195 -195
- package/src/Components/Visual/Switch/Switch.css +76 -76
- package/src/Components/Visual/Switch/Switch.html +8 -8
- package/src/Components/Visual/Switch/Switch.js +102 -102
- package/src/Components/Visual/TreeItem/TreeItem.css +36 -36
- package/src/Components/Visual/TreeItem/TreeItem.html +1 -1
- package/src/Components/Visual/TreeItem/TreeItem.js +126 -126
- package/src/Components/Visual/TreeView/TreeView.css +8 -8
- package/src/Components/Visual/TreeView/TreeView.html +1 -1
- package/src/Components/Visual/TreeView/TreeView.js +48 -48
- package/src/Components/components.js +27 -27
- package/src/Styles/sliceStyles.css +34 -34
- package/src/Themes/Dark.css +42 -42
- package/src/Themes/Light.css +31 -31
- package/src/Themes/Slice.css +47 -47
- package/src/routes.js +15 -15
- package/src/sliceConfig.json +73 -73
- package/src/testing.js +887 -887
- package/types/index.d.ts +207 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"mcp": {
|
|
3
|
+
"thinking": {
|
|
4
|
+
"type": "local",
|
|
5
|
+
"command": ["npx", "-y", "@modelcontextprotocol/server-sequential-thinking"],
|
|
6
|
+
"enabled": true
|
|
7
|
+
},
|
|
8
|
+
"slicemcp": {
|
|
9
|
+
"type": "local",
|
|
10
|
+
"command": ["npx", "-y", "slicejs-mcp"],
|
|
11
|
+
"enabled": true
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
}
|
package/LICENSE
CHANGED
|
@@ -1,21 +1,21 @@
|
|
|
1
|
-
MIT License
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2024 Victor Jose Kneider Alnahi and Julio Antonio Graterol Bracho
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in all
|
|
13
|
-
copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
-
SOFTWARE.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2024 Victor Jose Kneider Alnahi and Julio Antonio Graterol Bracho
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,174 +1,174 @@
|
|
|
1
|
-
<!-- Improved compatibility of back to top link: See: https://github.com/VKneider/slice.js/pull/73 -->
|
|
2
|
-
<a name="readme-top"></a>
|
|
3
|
-
<!--
|
|
4
|
-
*** Thanks for checking out the slice.js. If you have a suggestion
|
|
5
|
-
*** that would make this better, please fork the repo and create a pull request
|
|
6
|
-
*** or simply open an issue with the tag "enhancement".
|
|
7
|
-
*** Don't forget to give the project a star!
|
|
8
|
-
*** Thanks again! Now go create something AMAZING! :D
|
|
9
|
-
-->
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
<!-- PROJECT SHIELDS -->
|
|
14
|
-
<!--
|
|
15
|
-
*** I'm using markdown "reference style" links for readability.
|
|
16
|
-
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
17
|
-
*** See the bottom of this document for the declaration of the reference variables
|
|
18
|
-
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
19
|
-
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
20
|
-
-->
|
|
21
|
-
[![Contributors][contributors-shield]][contributors-url]
|
|
22
|
-
[![Forks][forks-shield]][forks-url]
|
|
23
|
-
[![Stargazers][stars-shield]][stars-url]
|
|
24
|
-
[![Issues][issues-shield]][issues-url]
|
|
25
|
-
[![MIT License][license-shield]][license-url]
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
<!-- PROJECT LOGO -->
|
|
30
|
-
<br />
|
|
31
|
-
<div align="center">
|
|
32
|
-
<a href="https://github.com/VKneider/slice.js">
|
|
33
|
-
<img src="readme_images/Slice.js-logo.svg" alt="Logo" width="150" height="150">
|
|
34
|
-
</a>
|
|
35
|
-
|
|
36
|
-
<h3 align="center">Slice.js</h3>
|
|
37
|
-
|
|
38
|
-
<p align="center">
|
|
39
|
-
Component-Based Web Development Framework
|
|
40
|
-
<br />
|
|
41
|
-
<a href="https://slice-js-docs.vercel.app/Documentation"><strong>Explore the docs »</strong></a>
|
|
42
|
-
<br />
|
|
43
|
-
<br />
|
|
44
|
-
<a href="https://slice-js-docs.vercel.app/">View Demo</a>
|
|
45
|
-
·
|
|
46
|
-
<a href="https://github.com/VKneider/slice.js/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
|
|
47
|
-
·
|
|
48
|
-
<a href="https://github.com/VKneider/slice.js/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
|
|
49
|
-
</p>
|
|
50
|
-
</div>
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
<!-- TABLE OF CONTENTS -->
|
|
55
|
-
<details>
|
|
56
|
-
<summary>Table of Contents</summary>
|
|
57
|
-
<ol>
|
|
58
|
-
<li>
|
|
59
|
-
<a href="#about-the-project">About The Project</a>
|
|
60
|
-
</li>
|
|
61
|
-
<li>
|
|
62
|
-
<a href="#getting-started">Getting Started</a>
|
|
63
|
-
<ul>
|
|
64
|
-
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
65
|
-
<li><a href="#installation">Installation</a></li>
|
|
66
|
-
</ul>
|
|
67
|
-
</li>
|
|
68
|
-
<li><a href="#roadmap">Roadmap</a></li>
|
|
69
|
-
<li><a href="#contributing">Contributing</a></li>
|
|
70
|
-
<li><a href="#license">License</a></li>
|
|
71
|
-
<li><a href="#contact">Contact</a></li>
|
|
72
|
-
</ol>
|
|
73
|
-
</details>
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
<!-- ABOUT THE PROJECT -->
|
|
78
|
-
## About The Project
|
|
79
|
-
|
|
80
|
-
[![Product Name Screen Shot][product-screenshot]](https://slice-js-docs.vercel.app/)
|
|
81
|
-
|
|
82
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
83
|
-
|
|
84
|
-
<!-- GETTING STARTED -->
|
|
85
|
-
## Getting Started
|
|
86
|
-
|
|
87
|
-
This is an example of how you may give instructions on setting up your project locally.
|
|
88
|
-
To get a local copy up and running follow these simple example steps.
|
|
89
|
-
|
|
90
|
-
### Installation
|
|
91
|
-
|
|
92
|
-
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
|
|
93
|
-
|
|
94
|
-
1. Install slicejs cli dependencies
|
|
95
|
-
```sh
|
|
96
|
-
npm i slicejs-cli
|
|
97
|
-
```
|
|
98
|
-
2. Initialize slice project
|
|
99
|
-
```sh
|
|
100
|
-
npm run slice:init
|
|
101
|
-
```
|
|
102
|
-
3. Build production output
|
|
103
|
-
```sh
|
|
104
|
-
npm run slice:build
|
|
105
|
-
```
|
|
106
|
-
4. Start production server
|
|
107
|
-
```sh
|
|
108
|
-
npm run slice:start
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
Production uses `publicFolders` from `sliceConfig.json` to expose public asset folders like
|
|
112
|
-
`/Themes`, `/Styles`, and `/assets`.
|
|
113
|
-
|
|
114
|
-
Structural framework components are bundled into a dedicated framework bundle during `slice build`
|
|
115
|
-
and served from `/dist/bundles/slice-bundle.framework.js`.
|
|
116
|
-
|
|
117
|
-
### Documentation Access
|
|
118
|
-
|
|
119
|
-
Slice.js provides an MCP (Model Context Protocol) server for programmatic access to documentation:
|
|
120
|
-
|
|
121
|
-
```bash
|
|
122
|
-
npx slicejs-mcp
|
|
123
|
-
```
|
|
124
|
-
|
|
125
|
-
This allows AI assistants and tools to query, search, and retrieve Slice.js documentation seamlessly.
|
|
126
|
-
|
|
127
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
<!-- ROADMAP -->
|
|
132
|
-
## Roadmap
|
|
133
|
-
|
|
134
|
-
- [x] Add Changelog
|
|
135
|
-
- [ ] Add Image visual component
|
|
136
|
-
- [ ] Modify Slice Card Visual Component
|
|
137
|
-
|
|
138
|
-
See the [open issues](https://github.com/VKneider/slice.js/issues) for a full list of proposed features (and known issues).
|
|
139
|
-
|
|
140
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
<!-- CONTRIBUTING -->
|
|
145
|
-
## Contributing
|
|
146
|
-
|
|
147
|
-
We welcome contributions to the project! Please make sure to review the guidelines in the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file before submitting any changes.
|
|
148
|
-
|
|
149
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
<!-- LICENSE -->
|
|
154
|
-
## License
|
|
155
|
-
|
|
156
|
-
Distributed under the MIT License. See `LICENSE` for more information.
|
|
157
|
-
|
|
158
|
-
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
159
|
-
|
|
160
|
-
<!-- MARKDOWN LINKS & IMAGES -->
|
|
161
|
-
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
162
|
-
[contributors-shield]: https://img.shields.io/github/contributors/VKneider/slice.js.svg?style=for-the-badge
|
|
163
|
-
[contributors-url]: https://github.com/VKneider/slice.js/graphs/contributors
|
|
164
|
-
[forks-shield]: https://img.shields.io/github/forks/VKneider/slice.js.svg?style=for-the-badge
|
|
165
|
-
[forks-url]: https://github.com/VKneider/slice.js/network/members
|
|
166
|
-
[stars-shield]: https://img.shields.io/github/stars/VKneider/slice.js.svg?style=for-the-badge
|
|
167
|
-
[stars-url]: https://github.com/VKneider/slice.js/stargazers
|
|
168
|
-
[issues-shield]: https://img.shields.io/github/issues/VKneider/slice.js.svg?style=for-the-badge
|
|
169
|
-
[issues-url]: https://github.com/VKneider/slice.js/issues
|
|
170
|
-
[license-shield]: https://img.shields.io/github/license/VKneider/slice.js.svg?style=for-the-badge
|
|
171
|
-
[license-url]: https://github.com/VKneider/slice.js/blob/master/LICENSE.txt
|
|
172
|
-
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
|
173
|
-
[linkedin-url]: https://linkedin.com/in/VKneider
|
|
174
|
-
[product-screenshot]: readme_images/screenshot.JPG
|
|
1
|
+
<!-- Improved compatibility of back to top link: See: https://github.com/VKneider/slice.js/pull/73 -->
|
|
2
|
+
<a name="readme-top"></a>
|
|
3
|
+
<!--
|
|
4
|
+
*** Thanks for checking out the slice.js. If you have a suggestion
|
|
5
|
+
*** that would make this better, please fork the repo and create a pull request
|
|
6
|
+
*** or simply open an issue with the tag "enhancement".
|
|
7
|
+
*** Don't forget to give the project a star!
|
|
8
|
+
*** Thanks again! Now go create something AMAZING! :D
|
|
9
|
+
-->
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<!-- PROJECT SHIELDS -->
|
|
14
|
+
<!--
|
|
15
|
+
*** I'm using markdown "reference style" links for readability.
|
|
16
|
+
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
|
|
17
|
+
*** See the bottom of this document for the declaration of the reference variables
|
|
18
|
+
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
|
|
19
|
+
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
|
|
20
|
+
-->
|
|
21
|
+
[![Contributors][contributors-shield]][contributors-url]
|
|
22
|
+
[![Forks][forks-shield]][forks-url]
|
|
23
|
+
[![Stargazers][stars-shield]][stars-url]
|
|
24
|
+
[![Issues][issues-shield]][issues-url]
|
|
25
|
+
[![MIT License][license-shield]][license-url]
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
<!-- PROJECT LOGO -->
|
|
30
|
+
<br />
|
|
31
|
+
<div align="center">
|
|
32
|
+
<a href="https://github.com/VKneider/slice.js">
|
|
33
|
+
<img src="readme_images/Slice.js-logo.svg" alt="Logo" width="150" height="150">
|
|
34
|
+
</a>
|
|
35
|
+
|
|
36
|
+
<h3 align="center">Slice.js</h3>
|
|
37
|
+
|
|
38
|
+
<p align="center">
|
|
39
|
+
Component-Based Web Development Framework
|
|
40
|
+
<br />
|
|
41
|
+
<a href="https://slice-js-docs.vercel.app/Documentation"><strong>Explore the docs »</strong></a>
|
|
42
|
+
<br />
|
|
43
|
+
<br />
|
|
44
|
+
<a href="https://slice-js-docs.vercel.app/">View Demo</a>
|
|
45
|
+
·
|
|
46
|
+
<a href="https://github.com/VKneider/slice.js/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
|
|
47
|
+
·
|
|
48
|
+
<a href="https://github.com/VKneider/slice.js/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
|
|
49
|
+
</p>
|
|
50
|
+
</div>
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
<!-- TABLE OF CONTENTS -->
|
|
55
|
+
<details>
|
|
56
|
+
<summary>Table of Contents</summary>
|
|
57
|
+
<ol>
|
|
58
|
+
<li>
|
|
59
|
+
<a href="#about-the-project">About The Project</a>
|
|
60
|
+
</li>
|
|
61
|
+
<li>
|
|
62
|
+
<a href="#getting-started">Getting Started</a>
|
|
63
|
+
<ul>
|
|
64
|
+
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
65
|
+
<li><a href="#installation">Installation</a></li>
|
|
66
|
+
</ul>
|
|
67
|
+
</li>
|
|
68
|
+
<li><a href="#roadmap">Roadmap</a></li>
|
|
69
|
+
<li><a href="#contributing">Contributing</a></li>
|
|
70
|
+
<li><a href="#license">License</a></li>
|
|
71
|
+
<li><a href="#contact">Contact</a></li>
|
|
72
|
+
</ol>
|
|
73
|
+
</details>
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
|
|
77
|
+
<!-- ABOUT THE PROJECT -->
|
|
78
|
+
## About The Project
|
|
79
|
+
|
|
80
|
+
[![Product Name Screen Shot][product-screenshot]](https://slice-js-docs.vercel.app/)
|
|
81
|
+
|
|
82
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
83
|
+
|
|
84
|
+
<!-- GETTING STARTED -->
|
|
85
|
+
## Getting Started
|
|
86
|
+
|
|
87
|
+
This is an example of how you may give instructions on setting up your project locally.
|
|
88
|
+
To get a local copy up and running follow these simple example steps.
|
|
89
|
+
|
|
90
|
+
### Installation
|
|
91
|
+
|
|
92
|
+
_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._
|
|
93
|
+
|
|
94
|
+
1. Install slicejs cli dependencies
|
|
95
|
+
```sh
|
|
96
|
+
npm i slicejs-cli
|
|
97
|
+
```
|
|
98
|
+
2. Initialize slice project
|
|
99
|
+
```sh
|
|
100
|
+
npm run slice:init
|
|
101
|
+
```
|
|
102
|
+
3. Build production output
|
|
103
|
+
```sh
|
|
104
|
+
npm run slice:build
|
|
105
|
+
```
|
|
106
|
+
4. Start production server
|
|
107
|
+
```sh
|
|
108
|
+
npm run slice:start
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Production uses `publicFolders` from `sliceConfig.json` to expose public asset folders like
|
|
112
|
+
`/Themes`, `/Styles`, and `/assets`.
|
|
113
|
+
|
|
114
|
+
Structural framework components are bundled into a dedicated framework bundle during `slice build`
|
|
115
|
+
and served from `/dist/bundles/slice-bundle.framework.js`.
|
|
116
|
+
|
|
117
|
+
### Documentation Access
|
|
118
|
+
|
|
119
|
+
Slice.js provides an MCP (Model Context Protocol) server for programmatic access to documentation:
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
npx slicejs-mcp
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
This allows AI assistants and tools to query, search, and retrieve Slice.js documentation seamlessly.
|
|
126
|
+
|
|
127
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<!-- ROADMAP -->
|
|
132
|
+
## Roadmap
|
|
133
|
+
|
|
134
|
+
- [x] Add Changelog
|
|
135
|
+
- [ ] Add Image visual component
|
|
136
|
+
- [ ] Modify Slice Card Visual Component
|
|
137
|
+
|
|
138
|
+
See the [open issues](https://github.com/VKneider/slice.js/issues) for a full list of proposed features (and known issues).
|
|
139
|
+
|
|
140
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
<!-- CONTRIBUTING -->
|
|
145
|
+
## Contributing
|
|
146
|
+
|
|
147
|
+
We welcome contributions to the project! Please make sure to review the guidelines in the [CONTRIBUTING.md](docs/CONTRIBUTING.md) file before submitting any changes.
|
|
148
|
+
|
|
149
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<!-- LICENSE -->
|
|
154
|
+
## License
|
|
155
|
+
|
|
156
|
+
Distributed under the MIT License. See `LICENSE` for more information.
|
|
157
|
+
|
|
158
|
+
<p align="right">(<a href="#readme-top">back to top</a>)</p>
|
|
159
|
+
|
|
160
|
+
<!-- MARKDOWN LINKS & IMAGES -->
|
|
161
|
+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
162
|
+
[contributors-shield]: https://img.shields.io/github/contributors/VKneider/slice.js.svg?style=for-the-badge
|
|
163
|
+
[contributors-url]: https://github.com/VKneider/slice.js/graphs/contributors
|
|
164
|
+
[forks-shield]: https://img.shields.io/github/forks/VKneider/slice.js.svg?style=for-the-badge
|
|
165
|
+
[forks-url]: https://github.com/VKneider/slice.js/network/members
|
|
166
|
+
[stars-shield]: https://img.shields.io/github/stars/VKneider/slice.js.svg?style=for-the-badge
|
|
167
|
+
[stars-url]: https://github.com/VKneider/slice.js/stargazers
|
|
168
|
+
[issues-shield]: https://img.shields.io/github/issues/VKneider/slice.js.svg?style=for-the-badge
|
|
169
|
+
[issues-url]: https://github.com/VKneider/slice.js/issues
|
|
170
|
+
[license-shield]: https://img.shields.io/github/license/VKneider/slice.js.svg?style=for-the-badge
|
|
171
|
+
[license-url]: https://github.com/VKneider/slice.js/blob/master/LICENSE.txt
|
|
172
|
+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
|
173
|
+
[linkedin-url]: https://linkedin.com/in/VKneider
|
|
174
|
+
[product-screenshot]: readme_images/screenshot.JPG
|