create-vite-hyperapp 1.0.0 → 1.0.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 +33 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1 +1,34 @@
|
|
|
1
1
|
# create-vite-hyperapp
|
|
2
|
+
|
|
3
|
+
Quickly scaffold new web-frontend projects using the [Hyperapp](https://hyperapp.dev) microframework, using the [Vite](https://vitejs.dev) bundler.
|
|
4
|
+
|
|
5
|
+
## Usage
|
|
6
|
+
|
|
7
|
+
With your shell in the folder _under which_ you would like to create your new project folder, run `npm create vite-hyperapp` and answer the questions.
|
|
8
|
+
|
|
9
|
+
To skip questions and do the entire setup directly in the command line, use the options:
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
Usage: npm create vite-hyperapp -- [TARGET_DIR] [OPTIONS]
|
|
13
|
+
|
|
14
|
+
Options:
|
|
15
|
+
-t, --typescript Use typescript
|
|
16
|
+
-s, --ssr Use server-side rendering
|
|
17
|
+
-n, --no-prompt Just do it, no questions asked
|
|
18
|
+
-h, --help Show this message
|
|
19
|
+
|
|
20
|
+
If no target dir is specified, the project name will be used.
|
|
21
|
+
If --no-prompt option is used, project name will be target dir
|
|
22
|
+
Default project-name/target-dir is 'hyperapp-project'
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## About the scaffolds
|
|
26
|
+
|
|
27
|
+
There are four basic templates that can be scaffolded up, depending on wether you want to use Typescript or not, and if you want to scaffold your project for SSR or not.
|
|
28
|
+
|
|
29
|
+
The vite-hyperapp connection is provided by [vite-plugin-hyperapp](https://github.com/zaceno/vite-plugin-hyperapp).
|
|
30
|
+
|
|
31
|
+
The SSR scaffolds are based directly on Vite's SSR docs for setting up a server with SSR support.
|
|
32
|
+
|
|
33
|
+
All templates have their views written in JSX (or TSX, for the TS-templates), but you can just as easily install a view-system of your preference (or use hyperapp's builtin `h` and `text`). Just name your files with `.js` or `.ts` extensions instead of `.jsx`.
|
|
34
|
+
|