zuby 1.0.5 → 1.0.6
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 +40 -0
- package/package.json +10 -3
package/README.md
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# Zuby.js
|
|
2
|
+
Zuby.js is a simple [Preact](https://preactjs.com/) framework for building JS apps that can combine the best of the SPA and MPA worlds.
|
|
3
|
+
The framework itself is based on [Vite](https://vitejs.dev/).
|
|
4
|
+
|
|
5
|
+
## Features:
|
|
6
|
+
- File-based routing (with similar syntax to Next.js)
|
|
7
|
+
- Build-time HTML pre-rendering
|
|
8
|
+
- Automatic for static paths
|
|
9
|
+
- Manual for dynamic paths
|
|
10
|
+
- Code splitting and lazy loading of pages
|
|
11
|
+
- Component rehydration
|
|
12
|
+
- Fast development server
|
|
13
|
+
- Built-in i18n localization support
|
|
14
|
+
|
|
15
|
+
Missing features:
|
|
16
|
+
- Server-side rendering
|
|
17
|
+
|
|
18
|
+
## For contributors
|
|
19
|
+
### Repository setup
|
|
20
|
+
Please see the [NVM guide](https://github.com/nvm-sh/nvm#installing-and-updating) how to install specific Node.js version on your device.
|
|
21
|
+
To set up this repository, run the following commands:
|
|
22
|
+
```
|
|
23
|
+
git clone git@gitlab.com:futrou/zuby.js.git
|
|
24
|
+
cd zuby.js
|
|
25
|
+
npm install
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Recommended versions
|
|
29
|
+
- Node.js: 18
|
|
30
|
+
- npm: 9
|
|
31
|
+
|
|
32
|
+
### Releases
|
|
33
|
+
Please follow these steps to release a new stable version of the package:
|
|
34
|
+
1. Check the current version in `package.json`. This version will be released. The patch version is automatically increased by CI and pushed to the master branch after each release. If you want to release a minor or major version, please change the version manually. Otherwise, you can skip this step.
|
|
35
|
+
2. Go to the page with [repository tags](https://gitlab.com/futrou/zuby.js/-/tags) and create a new tag from'master' with the version from `package.json` as the name (in the following format, `v1.0.0`).
|
|
36
|
+
3. This will trigger the CI pipeline, which will release the package, generate a changelog, and create a new release in the Gitlab UI.
|
|
37
|
+
4. That's it! 🎉 You can check the new release on [Gitlab releases page](https://gitlab.com/futrou/zuby.js/-/releases) and [NPM package page](https://www.npmjs.com/package/zuby).
|
|
38
|
+
|
|
39
|
+
## License
|
|
40
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "zuby",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.6",
|
|
4
4
|
"description": "The Preact Framework for building SPA apps using Vite",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.mjs",
|
|
7
7
|
"scripts": {
|
|
8
8
|
"release": "npm publish --access public ./dist/ ",
|
|
9
9
|
"bump-version": "npm version patch",
|
|
10
|
-
"build": "rm -rf dist/ && mkdir dist && cp -rf src/* package.json dist/",
|
|
10
|
+
"build": "rm -rf dist/ && mkdir dist && cp -rf src/* package.json README.md dist/",
|
|
11
11
|
"test": "echo \"Error: no test specified\" && exit 1"
|
|
12
12
|
},
|
|
13
13
|
"bugs": {
|
|
@@ -18,5 +18,12 @@
|
|
|
18
18
|
"repository": {
|
|
19
19
|
"type": "git",
|
|
20
20
|
"url": "git+https://gitlab.com/futrou/zuby.js.git"
|
|
21
|
-
}
|
|
21
|
+
},
|
|
22
|
+
"keywords": [
|
|
23
|
+
"preact",
|
|
24
|
+
"vite",
|
|
25
|
+
"spa",
|
|
26
|
+
"framework",
|
|
27
|
+
"web"
|
|
28
|
+
]
|
|
22
29
|
}
|