slicejs-web-framework 2.3.0 → 2.3.1

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,156 +1,155 @@
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. Start web server
103
- ```sh
104
- npm run slice:start
105
- ```
106
-
107
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
108
-
109
-
110
-
111
- <!-- ROADMAP -->
112
- ## Roadmap
113
-
114
- - [x] Add Changelog
115
- - [ ] Add Image visual component
116
- - [ ] Modify Slice Card Visual Component
117
- - [ ] Create internationalization Translator Service component.
118
-
119
- See the [open issues](https://github.com/VKneider/slice.js/issues) for a full list of proposed features (and known issues).
120
-
121
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
122
-
123
-
124
-
125
- <!-- CONTRIBUTING -->
126
- ## Contributing
127
-
128
- 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.
129
-
130
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
131
-
132
-
133
-
134
- <!-- LICENSE -->
135
- ## License
136
-
137
- Distributed under the MIT License. See `LICENSE` for more information.
138
-
139
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
140
-
141
- <!-- MARKDOWN LINKS & IMAGES -->
142
- <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
143
- [contributors-shield]: https://img.shields.io/github/contributors/VKneider/slice.js.svg?style=for-the-badge
144
- [contributors-url]: https://github.com/VKneider/slice.js/graphs/contributors
145
- [forks-shield]: https://img.shields.io/github/forks/VKneider/slice.js.svg?style=for-the-badge
146
- [forks-url]: https://github.com/VKneider/slice.js/network/members
147
- [stars-shield]: https://img.shields.io/github/stars/VKneider/slice.js.svg?style=for-the-badge
148
- [stars-url]: https://github.com/VKneider/slice.js/stargazers
149
- [issues-shield]: https://img.shields.io/github/issues/VKneider/slice.js.svg?style=for-the-badge
150
- [issues-url]: https://github.com/VKneider/slice.js/issues
151
- [license-shield]: https://img.shields.io/github/license/VKneider/slice.js.svg?style=for-the-badge
152
- [license-url]: https://github.com/VKneider/slice.js/blob/master/LICENSE.txt
153
- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
154
- [linkedin-url]: https://linkedin.com/in/VKneider
155
- [product-screenshot]: readme_images/screenshot.JPG
156
-
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. Start web server
103
+ ```sh
104
+ npm run slice:start
105
+ ```
106
+
107
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
108
+
109
+
110
+
111
+ <!-- ROADMAP -->
112
+ ## Roadmap
113
+
114
+ - [x] Add Changelog
115
+ - [ ] Add Image visual component
116
+ - [ ] Modify Slice Card Visual Component
117
+
118
+ See the [open issues](https://github.com/VKneider/slice.js/issues) for a full list of proposed features (and known issues).
119
+
120
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
121
+
122
+
123
+
124
+ <!-- CONTRIBUTING -->
125
+ ## Contributing
126
+
127
+ 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.
128
+
129
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
130
+
131
+
132
+
133
+ <!-- LICENSE -->
134
+ ## License
135
+
136
+ Distributed under the MIT License. See `LICENSE` for more information.
137
+
138
+ <p align="right">(<a href="#readme-top">back to top</a>)</p>
139
+
140
+ <!-- MARKDOWN LINKS & IMAGES -->
141
+ <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
142
+ [contributors-shield]: https://img.shields.io/github/contributors/VKneider/slice.js.svg?style=for-the-badge
143
+ [contributors-url]: https://github.com/VKneider/slice.js/graphs/contributors
144
+ [forks-shield]: https://img.shields.io/github/forks/VKneider/slice.js.svg?style=for-the-badge
145
+ [forks-url]: https://github.com/VKneider/slice.js/network/members
146
+ [stars-shield]: https://img.shields.io/github/stars/VKneider/slice.js.svg?style=for-the-badge
147
+ [stars-url]: https://github.com/VKneider/slice.js/stargazers
148
+ [issues-shield]: https://img.shields.io/github/issues/VKneider/slice.js.svg?style=for-the-badge
149
+ [issues-url]: https://github.com/VKneider/slice.js/issues
150
+ [license-shield]: https://img.shields.io/github/license/VKneider/slice.js.svg?style=for-the-badge
151
+ [license-url]: https://github.com/VKneider/slice.js/blob/master/LICENSE.txt
152
+ [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
153
+ [linkedin-url]: https://linkedin.com/in/VKneider
154
+ [product-screenshot]: readme_images/screenshot.JPG
155
+