chore(packages): initialize README; bump versions
This commit is contained in:
Ayo
parent
60f0774156
commit
5bf0940868
7 changed files with 196 additions and 12 deletions
16
package-lock.json
generated
16
package-lock.json
generated
|
|
@ -3960,13 +3960,13 @@
|
|||
},
|
||||
"packages/config": {
|
||||
"name": "@mcflyjs/config",
|
||||
"version": "0.0.2",
|
||||
"version": "0.0.3",
|
||||
"license": "MIT",
|
||||
"devDependencies": {}
|
||||
},
|
||||
"packages/core": {
|
||||
"name": "@mcflyjs/core",
|
||||
"version": "0.2.1",
|
||||
"version": "0.2.2",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"esprima": "^4.0.1",
|
||||
|
|
@ -3977,7 +3977,7 @@
|
|||
}
|
||||
},
|
||||
"packages/create-mcfly": {
|
||||
"version": "0.1.1",
|
||||
"version": "0.1.2",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"giget": "^1.1.3"
|
||||
|
|
@ -4004,9 +4004,7 @@
|
|||
"dependencies": {
|
||||
"@mcflyjs/config": "latest",
|
||||
"@mcflyjs/core": "latest",
|
||||
"esprima": "^4.0.1",
|
||||
"nitropack": "latest",
|
||||
"ultrahtml": "^1.5.2"
|
||||
"nitropack": "latest"
|
||||
}
|
||||
},
|
||||
"templates/basic/node_modules/@mcflyjs/config": {
|
||||
|
|
@ -4015,9 +4013,9 @@
|
|||
"integrity": "sha512-OcufnHOebm8PW55sb0tMJV5y0pMnHiJeVZ4B+5Cg3Wjiz1cCk46qsGuGVLoqNTluaBkDNnJL8k6pdswYOp+mTw=="
|
||||
},
|
||||
"templates/basic/node_modules/@mcflyjs/core": {
|
||||
"version": "0.2.0",
|
||||
"resolved": "https://registry.npmjs.org/@mcflyjs/core/-/core-0.2.0.tgz",
|
||||
"integrity": "sha512-c6uYrgJMqlThoA7BAEgXJvD2NDvr8/z6UqYl2odiemWVSuJxlXT8eThr7GTfSVSwkhufyB8+kTC5hyLsJmI9HA==",
|
||||
"version": "0.2.1",
|
||||
"resolved": "https://registry.npmjs.org/@mcflyjs/core/-/core-0.2.1.tgz",
|
||||
"integrity": "sha512-vP8RMEMeOczxzSRojn7l1v7+G92MIPRKSpguJGXISm6PiMJssBac5pS/AboCWGTkasgxvtMf4erDokyKQK7cWQ==",
|
||||
"dependencies": {
|
||||
"esprima": "^4.0.1",
|
||||
"h3": "^1.8.2",
|
||||
|
|
|
|||
62
packages/config/README.md
Normal file
62
packages/config/README.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
<p align="center">
|
||||
<img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="rRick & Morty cartoon" />
|
||||
</p>
|
||||
|
||||
<h1 align="center">McFly</h1>
|
||||
|
||||
<p align="center"><strong>McFly</strong> is a no-framework framework<br />that assists in leveraging the web platform</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/from-the_future-blue?style=flat" />
|
||||
<img src="https://img.shields.io/badge/status-legit-purple?style=flat" />
|
||||
<a href="https://mc-fly.vercel.app/demo" target="_blank"><img src="https://img.shields.io/badge/see-the_demo_↗️-blue?style=flat&colorB=28CF8D" /></a>
|
||||
</p>
|
||||
|
||||
## Installation
|
||||
|
||||
Run the following to generate a McFly starter project:
|
||||
```
|
||||
npm create mcfly@latest
|
||||
```
|
||||
|
||||
## Features
|
||||
The time has come for vanilla Web tech. 🎉
|
||||
|
||||
✅ Create web apps with vanilla custom elements<br>
|
||||
✅ Write real .HTML files<br>
|
||||
✅ Have no frameworks or reactivity libraries on the browser<br>
|
||||
✅ Use server-side rendering<br>
|
||||
✅ Deploy anywhere<br>
|
||||
|
||||
## Special directories
|
||||
**1. `src/pages`**
|
||||
- file based routing for `.html` files
|
||||
- directly use custom elements & static fragments (no imports or registry maintenance needed)
|
||||
- use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
|
||||
|
||||
**2. `src/components`**
|
||||
- custom element constructor files (only `.js` files for now)
|
||||
- all components are automatically registered using their file names; a `hello-world.js` component can be used as `<hello-world>`
|
||||
- static `.html` fragments; a `my-header.html` fragment can be directly used as `<my-header>`
|
||||
|
||||
## McFly config
|
||||
|
||||
To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts
|
||||
|
||||
```js
|
||||
import defineConfig from "./packages/define-config";
|
||||
|
||||
export default defineConfig({
|
||||
components: "js",
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
## More info
|
||||
This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [**Nitro**](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [**Web Component Base**](https://ayco.io/n/web-component-base) class.
|
||||
|
||||
**Nitro** is the same production-grade web server powering [**Nuxt**](https://nuxt.com/)
|
||||
|
||||
---
|
||||
*Just keep building*<br />
|
||||
*A project by [Ayo Ayco](https://ayco.io)*
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@mcflyjs/config",
|
||||
"version": "0.0.2",
|
||||
"version": "0.0.3",
|
||||
"description": "Nitro configuration for McFly apps",
|
||||
"main": "index.ts",
|
||||
"devDependencies": {},
|
||||
|
|
|
|||
62
packages/core/README.md
Normal file
62
packages/core/README.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
<p align="center">
|
||||
<img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="rRick & Morty cartoon" />
|
||||
</p>
|
||||
|
||||
<h1 align="center">McFly</h1>
|
||||
|
||||
<p align="center"><strong>McFly</strong> is a no-framework framework<br />that assists in leveraging the web platform</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/from-the_future-blue?style=flat" />
|
||||
<img src="https://img.shields.io/badge/status-legit-purple?style=flat" />
|
||||
<a href="https://mc-fly.vercel.app/demo" target="_blank"><img src="https://img.shields.io/badge/see-the_demo_↗️-blue?style=flat&colorB=28CF8D" /></a>
|
||||
</p>
|
||||
|
||||
## Installation
|
||||
|
||||
Run the following to generate a McFly starter project:
|
||||
```
|
||||
npm create mcfly@latest
|
||||
```
|
||||
|
||||
## Features
|
||||
The time has come for vanilla Web tech. 🎉
|
||||
|
||||
✅ Create web apps with vanilla custom elements<br>
|
||||
✅ Write real .HTML files<br>
|
||||
✅ Have no frameworks or reactivity libraries on the browser<br>
|
||||
✅ Use server-side rendering<br>
|
||||
✅ Deploy anywhere<br>
|
||||
|
||||
## Special directories
|
||||
**1. `src/pages`**
|
||||
- file based routing for `.html` files
|
||||
- directly use custom elements & static fragments (no imports or registry maintenance needed)
|
||||
- use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
|
||||
|
||||
**2. `src/components`**
|
||||
- custom element constructor files (only `.js` files for now)
|
||||
- all components are automatically registered using their file names; a `hello-world.js` component can be used as `<hello-world>`
|
||||
- static `.html` fragments; a `my-header.html` fragment can be directly used as `<my-header>`
|
||||
|
||||
## McFly config
|
||||
|
||||
To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts
|
||||
|
||||
```js
|
||||
import defineConfig from "./packages/define-config";
|
||||
|
||||
export default defineConfig({
|
||||
components: "js",
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
## More info
|
||||
This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [**Nitro**](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [**Web Component Base**](https://ayco.io/n/web-component-base) class.
|
||||
|
||||
**Nitro** is the same production-grade web server powering [**Nuxt**](https://nuxt.com/)
|
||||
|
||||
---
|
||||
*Just keep building*<br />
|
||||
*A project by [Ayo Ayco](https://ayco.io)*
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "@mcflyjs/core",
|
||||
"version": "0.2.1",
|
||||
"version": "0.2.2",
|
||||
"description": "McFly core package",
|
||||
"main": "event-handler.mjs",
|
||||
"files": [
|
||||
|
|
|
|||
62
packages/create-mcfly/README.md
Normal file
62
packages/create-mcfly/README.md
Normal file
|
|
@ -0,0 +1,62 @@
|
|||
<p align="center">
|
||||
<img width="250" src="https://github.com/ayoayco/McFly/assets/4262489/719a51c6-4858-4e3c-9856-c5af0e9be1bd" alt="rRick & Morty cartoon" />
|
||||
</p>
|
||||
|
||||
<h1 align="center">McFly</h1>
|
||||
|
||||
<p align="center"><strong>McFly</strong> is a no-framework framework<br />that assists in leveraging the web platform</p>
|
||||
|
||||
<p align="center">
|
||||
<img src="https://img.shields.io/badge/from-the_future-blue?style=flat" />
|
||||
<img src="https://img.shields.io/badge/status-legit-purple?style=flat" />
|
||||
<a href="https://mc-fly.vercel.app/demo" target="_blank"><img src="https://img.shields.io/badge/see-the_demo_↗️-blue?style=flat&colorB=28CF8D" /></a>
|
||||
</p>
|
||||
|
||||
## Installation
|
||||
|
||||
Run the following to generate a McFly starter project:
|
||||
```
|
||||
npm create mcfly@latest
|
||||
```
|
||||
|
||||
## Features
|
||||
The time has come for vanilla Web tech. 🎉
|
||||
|
||||
✅ Create web apps with vanilla custom elements<br>
|
||||
✅ Write real .HTML files<br>
|
||||
✅ Have no frameworks or reactivity libraries on the browser<br>
|
||||
✅ Use server-side rendering<br>
|
||||
✅ Deploy anywhere<br>
|
||||
|
||||
## Special directories
|
||||
**1. `src/pages`**
|
||||
- file based routing for `.html` files
|
||||
- directly use custom elements & static fragments (no imports or registry maintenance needed)
|
||||
- use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
|
||||
|
||||
**2. `src/components`**
|
||||
- custom element constructor files (only `.js` files for now)
|
||||
- all components are automatically registered using their file names; a `hello-world.js` component can be used as `<hello-world>`
|
||||
- static `.html` fragments; a `my-header.html` fragment can be directly used as `<my-header>`
|
||||
|
||||
## McFly config
|
||||
|
||||
To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts
|
||||
|
||||
```js
|
||||
import defineConfig from "./packages/define-config";
|
||||
|
||||
export default defineConfig({
|
||||
components: "js",
|
||||
});
|
||||
|
||||
```
|
||||
|
||||
## More info
|
||||
This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [**Nitro**](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [**Web Component Base**](https://ayco.io/n/web-component-base) class.
|
||||
|
||||
**Nitro** is the same production-grade web server powering [**Nuxt**](https://nuxt.com/)
|
||||
|
||||
---
|
||||
*Just keep building*<br />
|
||||
*A project by [Ayo Ayco](https://ayco.io)*
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "create-mcfly",
|
||||
"version": "0.1.1",
|
||||
"version": "0.1.2",
|
||||
"bin": {
|
||||
"create-mcfly": "./index.js"
|
||||
},
|
||||
|
|
|
|||
Loading…
Reference in a new issue