slicejs-web-framework 1.0.22 → 1.0.23

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.
Files changed (2) hide show
  1. package/README.md +15 -66
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -38,10 +38,10 @@
38
38
  <p align="center">
39
39
  Component-Based Web Development Framework
40
40
  <br />
41
- <a href="https://slice-js.vercel.app/src/App/Documentation/"><strong>Explore the docs »</strong></a>
41
+ <a href="https://slice-js-docs.vercel.app/Documentation"><strong>Explore the docs »</strong></a>
42
42
  <br />
43
43
  <br />
44
- <a href="https://slice-js.vercel.app/src/App/LandingPage/">View Demo</a>
44
+ <a href="https://slice-js-docs.vercel.app/">View Demo</a>
45
45
  ·
46
46
  <a href="https://github.com/VKneider/slice.js/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
47
47
  ·
@@ -77,7 +77,7 @@
77
77
  <!-- ABOUT THE PROJECT -->
78
78
  ## About The Project
79
79
 
80
- [![Product Name Screen Shot][product-screenshot]](https://slice-js.vercel.app/src/App/LandingPage/)
80
+ [![Product Name Screen Shot][product-screenshot]](https://slice-js-docs.vercel.app/)
81
81
 
82
82
  <p align="right">(<a href="#readme-top">back to top</a>)</p>
83
83
 
@@ -87,30 +87,21 @@
87
87
  This is an example of how you may give instructions on setting up your project locally.
88
88
  To get a local copy up and running follow these simple example steps.
89
89
 
90
- ### Prerequisites
91
-
92
- This is an example of how to list things you need to use the software and how to install them.
93
- * npm
94
- ```sh
95
- npm install npm@latest -g
96
- ```
97
-
98
90
  ### Installation
99
91
 
100
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._
101
93
 
102
- 1. Get a free API Key at [https://example.com](https://example.com)
103
- 2. Clone the repo
94
+ 1. Install slicejs cli dependencies
104
95
  ```sh
105
- git clone https://github.com/your_username_/Project-Name.git
96
+ npm i slicejs-cli
106
97
  ```
107
- 3. Install NPM packages
98
+ 2. Initialize slice project
108
99
  ```sh
109
- npm install
100
+ npm run slice:init
110
101
  ```
111
- 4. Enter your API in `config.js`
112
- ```js
113
- const API_KEY = 'ENTER YOUR API';
102
+ 3. Start web server
103
+ ```sh
104
+ npm run slice:start
114
105
  ```
115
106
 
116
107
  <p align="right">(<a href="#readme-top">back to top</a>)</p>
@@ -121,12 +112,9 @@ _Below is an example of how you can instruct your audience on installing and set
121
112
  ## Roadmap
122
113
 
123
114
  - [x] Add Changelog
124
- - [x] Add Image visual component
125
- - [ ] Add Router structural component
126
- - [ ] Add "components" document to easily copy & paste sections of the readme
127
- - [ ] Multi-language Support
128
- - [ ] Chinese
129
- - [ ] Spanish
115
+ - [ ] Add Image visual component
116
+ - [ ] Modify Slice Card Visual Component
117
+ - [ ] Create internationalization Translator Service component.
130
118
 
131
119
  See the [open issues](https://github.com/VKneider/slice.js/issues) for a full list of proposed features (and known issues).
132
120
 
@@ -137,16 +125,7 @@ See the [open issues](https://github.com/VKneider/slice.js/issues) for a full li
137
125
  <!-- CONTRIBUTING -->
138
126
  ## Contributing
139
127
 
140
- Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
141
-
142
- If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
143
- Don't forget to give the project a star! Thanks again!
144
-
145
- 1. Fork the Project
146
- 2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
147
- 3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
148
- 4. Push to the Branch (`git push origin feature/AmazingFeature`)
149
- 5. Open a Pull Request
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.
150
129
 
151
130
  <p align="right">(<a href="#readme-top">back to top</a>)</p>
152
131
 
@@ -159,21 +138,6 @@ Distributed under the MIT License. See `LICENSE` for more information.
159
138
 
160
139
  <p align="right">(<a href="#readme-top">back to top</a>)</p>
161
140
 
162
-
163
-
164
- <!-- CONTACT -->
165
- ## Contact
166
-
167
- Your Name - [@your_twitter](https://twitter.com/your_username) - email@example.com
168
-
169
- Project Link: [https://github.com/VKneider/slice.js](https://github.com/VKneider/slice.js)
170
-
171
- <p align="right">(<a href="#readme-top">back to top</a>)</p>
172
-
173
-
174
-
175
-
176
-
177
141
  <!-- MARKDOWN LINKS & IMAGES -->
178
142
  <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
179
143
  [contributors-shield]: https://img.shields.io/github/contributors/VKneider/slice.js.svg?style=for-the-badge
@@ -189,19 +153,4 @@ Project Link: [https://github.com/VKneider/slice.js](https://github.com/VKneider
189
153
  [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
190
154
  [linkedin-url]: https://linkedin.com/in/VKneider
191
155
  [product-screenshot]: readme_images/screenshot.JPG
192
- [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
193
- [Next-url]: https://nextjs.org/
194
- [React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
195
- [React-url]: https://reactjs.org/
196
- [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
197
- [Vue-url]: https://vuejs.org/
198
- [Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
199
- [Angular-url]: https://angular.io/
200
- [Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
201
- [Svelte-url]: https://svelte.dev/
202
- [Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
203
- [Laravel-url]: https://laravel.com
204
- [Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
205
- [Bootstrap-url]: https://getbootstrap.com
206
- [JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
207
- [JQuery-url]: https://jquery.com
156
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "slicejs-web-framework",
3
- "version": "1.0.22",
3
+ "version": "1.0.23",
4
4
  "description": "",
5
5
  "engines": {
6
6
  "node": ">=20"