slicejs-web-framework 3.2.3 → 3.3.0

package/.opencode/opencode.json

@@ -1,14 +1,14 @@
-{
-  "mcp": {
-    "thinking": {
-      "type": "local",
-      "command": ["npx", "-y", "@modelcontextprotocol/server-sequential-thinking"],
-      "enabled": true
-    },
-    "slicemcp": {
-      "type": "local",
-      "command": ["npx", "-y", "slicejs-mcp"],
-      "enabled": true
-    }
-}
+{
+  "mcp": {
+    "thinking": {
+      "type": "local",
+      "command": ["npx", "-y", "@modelcontextprotocol/server-sequential-thinking"],
+      "enabled": true
+    },
+    "slicemcp": {
+      "type": "local",
+      "command": ["npx", "-y", "slicejs-mcp"],
+      "enabled": true
+    }
+}
 }

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2024 Victor Jose Kneider Alnahi and Julio Antonio Graterol Bracho
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2024 Victor Jose Kneider Alnahi and Julio Antonio Graterol Bracho
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,174 +1,97 @@
-<!-- Improved compatibility of back to top link: See: https://github.com/VKneider/slice.js/pull/73 -->
-<a name="readme-top"></a>
-<!--
-*** Thanks for checking out the slice.js. If you have a suggestion
-*** that would make this better, please fork the repo and create a pull request
-*** or simply open an issue with the tag "enhancement".
-*** Don't forget to give the project a star!
-*** Thanks again! Now go create something AMAZING! :D
--->
-
-
-
-<!-- PROJECT SHIELDS -->
-<!--
-*** I'm using markdown "reference style" links for readability.
-*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
-*** See the bottom of this document for the declaration of the reference variables
-*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
-*** https://www.markdownguide.org/basic-syntax/#reference-style-links
--->
-[![Contributors][contributors-shield]][contributors-url]
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
-[![MIT License][license-shield]][license-url]
-
-
-
-<!-- PROJECT LOGO -->
-<br />
-<div align="center">
-  <a href="https://github.com/VKneider/slice.js">
-    <img src="readme_images/Slice.js-logo.svg" alt="Logo" width="150" height="150">
-  </a>
-
-  <h3 align="center">Slice.js</h3>
-
-  <p align="center">
-    Component-Based Web Development Framework
-    <br />
-    <a href="https://slice-js-docs.vercel.app/Documentation"><strong>Explore the docs »</strong></a>
-    <br />
-    <br />
-    <a href="https://slice-js-docs.vercel.app/">View Demo</a>
-    ·
-    <a href="https://github.com/VKneider/slice.js/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
-    ·
-    <a href="https://github.com/VKneider/slice.js/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
-  </p>
-</div>
-
-
-
-<!-- TABLE OF CONTENTS -->
-<details>
-  <summary>Table of Contents</summary>
-  <ol>
-    <li>
-      <a href="#about-the-project">About The Project</a>
-    </li>
-    <li>
-      <a href="#getting-started">Getting Started</a>
-      <ul>
-        <li><a href="#prerequisites">Prerequisites</a></li>
-        <li><a href="#installation">Installation</a></li>
-      </ul>
-    </li>
-    <li><a href="#roadmap">Roadmap</a></li>
-    <li><a href="#contributing">Contributing</a></li>
-    <li><a href="#license">License</a></li>
-    <li><a href="#contact">Contact</a></li>
-  </ol>
-</details>
-
-
-
-<!-- ABOUT THE PROJECT -->
-## About The Project
-
-[![Product Name Screen Shot][product-screenshot]](https://slice-js-docs.vercel.app/)
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- GETTING STARTED -->
-## Getting Started
-
-This is an example of how you may give instructions on setting up your project locally.
-To get a local copy up and running follow these simple example steps.
-
-### Installation
-
-_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._
-
-1. Install slicejs cli dependencies
-   ```sh
-   npm i slicejs-cli
-   ```
-2. Initialize slice project
-   ```sh
-   npm run slice:init
-   ```
-  3. Build production output
-     ```sh
-     npm run slice:build
-     ```
-  4. Start production server
-     ```sh
-     npm run slice:start
-     ```
-
-Production uses `publicFolders` from `sliceConfig.json` to expose public asset folders like
-`/Themes`, `/Styles`, and `/assets`.
-
-Structural framework components are bundled into a dedicated framework bundle during `slice build`
-and served from `/dist/bundles/slice-bundle.framework.js`.
-
-### Documentation Access
-
-Slice.js provides an MCP (Model Context Protocol) server for programmatic access to documentation:
-
-```bash
-npx slicejs-mcp
-```
-
-This allows AI assistants and tools to query, search, and retrieve Slice.js documentation seamlessly.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-
-
-<!-- ROADMAP -->
-## Roadmap
-
-- [x] Add Changelog
-- [ ] Add Image visual component
-- [ ] Modify Slice Card Visual Component
-
-See the [open issues](https://github.com/VKneider/slice.js/issues) for a full list of proposed features (and known issues).
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-
-
-<!-- CONTRIBUTING -->
-## Contributing
-
-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.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-
-
-<!-- LICENSE -->
-## License
-
-Distributed under the MIT License. See `LICENSE` for more information.
-
-<p align="right">(<a href="#readme-top">back to top</a>)</p>
-
-<!-- MARKDOWN LINKS & IMAGES -->
-<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
-[contributors-shield]: https://img.shields.io/github/contributors/VKneider/slice.js.svg?style=for-the-badge
-[contributors-url]: https://github.com/VKneider/slice.js/graphs/contributors
-[forks-shield]: https://img.shields.io/github/forks/VKneider/slice.js.svg?style=for-the-badge
-[forks-url]: https://github.com/VKneider/slice.js/network/members
-[stars-shield]: https://img.shields.io/github/stars/VKneider/slice.js.svg?style=for-the-badge
-[stars-url]: https://github.com/VKneider/slice.js/stargazers
-[issues-shield]: https://img.shields.io/github/issues/VKneider/slice.js.svg?style=for-the-badge
-[issues-url]: https://github.com/VKneider/slice.js/issues
-[license-shield]: https://img.shields.io/github/license/VKneider/slice.js.svg?style=for-the-badge
-[license-url]: https://github.com/VKneider/slice.js/blob/master/LICENSE.txt
-[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/VKneider
-[product-screenshot]: readme_images/screenshot.JPG
+<div align="center">
+  <img src="readme_images/Slice.js-logo.svg" alt="Slice.js logo" width="150" />
+  <h1>Slice.js</h1>
+  <p>Component-Based Web Development Framework</p>
+  <p>
+    <a href="https://slice-js-docs.vercel.app/Documentation"><strong>Explore the docs »</strong></a>
+    <br />
+    <a href="https://slice-js-docs.vercel.app/">View Demo</a>
+    ·
+    <a href="https://github.com/VKneider/slice.js/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    ·
+    <a href="https://github.com/VKneider/slice.js/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
+  </p>
+</div>
+
+## About this repository
+
+This repository contains the core of the Slice.js framework: the component runtime, routing system, bundle engine, and framework API. It is the package published as `slicejs-web-framework` on npm.
+
+## Prerequisites
+
+- Node.js >= 20
+- npm or pnpm
+
+## Local development
+
+1. **Clone the repository**
+   ```bash
+   git clone https://github.com/VKneider/slice.js.git
+   cd slice.js
+   ```
+
+2. **Install dependencies**
+   ```bash
+   npm install
+   ```
+
+3. **Initialize a test project** (optional, for CLI-based development)
+   ```bash
+   npx slicejs-cli init
+   ```
+
+4. **Test changes locally**
+   ```bash
+   npx slicejs-cli dev
+   ```
+
+## Available commands
+
+The framework does not expose commands directly. Use it through the CLI (`slicejs-cli`):
+
+| Command | Description |
+|---------|-------------|
+| `npx slicejs-cli init` | Initialize a Slice.js project |
+| `npx slicejs-cli dev` | Start development server |
+| `npx slicejs-cli build` | Build for production |
+| `npx slicejs-cli start` | Serve production build |
+
+## Documentation
+
+Full documentation is available at [slice-js-docs.vercel.app](https://slice-js-docs.vercel.app/Documentation).
+
+Slice.js also provides an MCP server for programmatic documentation access:
+
+```bash
+npx slicejs-mcp
+```
+
+This allows AI assistants and tools to query, search, and retrieve Slice.js documentation.
+
+## Project structure
+
+```
+slice.js/
+├── api/           # Framework API server
+├── src/           # Runtime source code
+│   ├── App/       # Application engine
+│   ├── Components/# Component system
+│   └── ...        # Routing, bundles, utilities
+├── Slice/         # Visual component framework
+├── types/         # TypeScript declarations
+└── docs/          # Contribution guides
+```
+
+## Contributing
+
+We welcome contributions. Please review the guidelines in [CONTRIBUTING.md](docs/CONTRIBUTING.md) before submitting changes.
+
+## License
+
+Distributed under the MIT License. See `LICENSE` for more information.
+
+## Contact
+
+Slice.js - [@VKneider](https://github.com/VKneider)
+
+Project Link: [https://github.com/VKneider/slice.js](https://github.com/VKneider/slice.js)