chore: update README.md
This commit is contained in:
parent
62e079efef
commit
c9bff2ae95
1 changed files with 18 additions and 16 deletions
34
README.md
34
README.md
|
@ -2,6 +2,24 @@
|
||||||
|
|
||||||
This is a Proof of Concept and testing ground for using [Nitro](https://nitro.unjs.io) and vanilla JS custom elements using my [Web Component Base](https://ayco.io/n/web-component-base) class.
|
This is a Proof of Concept and testing ground for using [Nitro](https://nitro.unjs.io) and vanilla JS custom elements using my [Web Component Base](https://ayco.io/n/web-component-base) class.
|
||||||
|
|
||||||
|
## Ambitious Goals
|
||||||
|
We want a way to:
|
||||||
|
1. create web apps with vanilla custom elements
|
||||||
|
1. write real .HTML files
|
||||||
|
1. no frameworks or reactivity libraries on the browser
|
||||||
|
1. easy server APIs authoring
|
||||||
|
1. server-side pre-rendering
|
||||||
|
1. control on when and where JS is downloaded for interactive elements
|
||||||
|
|
||||||
|
## Special directories
|
||||||
|
**1. `src/pages`**
|
||||||
|
- file based routing for `.html` files
|
||||||
|
- directly use custom elements (no registry maintenance needed)
|
||||||
|
|
||||||
|
**2. `src/components`**
|
||||||
|
- custom element constructor class files go here (only `.js` files for now)
|
||||||
|
- all components are automatically registered using their file names (e.g., a `hello-world.js` component can be used as `<hello-world>` element)
|
||||||
|
|
||||||
## Setting up
|
## Setting up
|
||||||
|
|
||||||
Do the following steps to get you started:
|
Do the following steps to get you started:
|
||||||
|
@ -26,25 +44,9 @@ npm run dev
|
||||||
|
|
||||||
4. open the browser to `https://localhost:3000` (or what the dev server said)
|
4. open the browser to `https://localhost:3000` (or what the dev server said)
|
||||||
|
|
||||||
## Special directories
|
|
||||||
**src/pages**
|
|
||||||
- file based routing for `.html` files
|
|
||||||
|
|
||||||
**src/components**
|
|
||||||
- custom element constructor class files go here (only `.js` files for now)
|
|
||||||
- all components are automatically registered using their file names (e.g., a `hello-world.js` component can be used as `<hello-world>` element)
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Ambitious Goals
|
|
||||||
We want a way to:
|
|
||||||
1. create web apps with vanilla custom elements
|
|
||||||
1. write real .HTML files
|
|
||||||
1. no frameworks or reactivity libraries on the browser
|
|
||||||
1. easy server APIs authoring
|
|
||||||
1. server-side pre-rendering
|
|
||||||
1. control on when and where JS is downloaded for interactive elements
|
|
||||||
|
|
||||||
## More info
|
## More info
|
||||||
|
|
||||||
This project was generated from Nitro starter guide. Look at the [Nitro documentation](https://nitro.unjs.io/) to learn more.
|
This project was generated from Nitro starter guide. Look at the [Nitro documentation](https://nitro.unjs.io/) to learn more.
|
||||||
|
|
Loading…
Reference in a new issue