* feat: move defineMcFlyConfig to @mcflyjs/config * feat: move defineMcFlyConfig to config package * feat: programmatically build nitro dev server * chore: bump versions * feat: spread nitro config if exists * chore: use nitro build programmatically * feat: use nitro programmatically in prepare command * feat: expose types for NitroConfig & McFlyConfig * feat: use c12 to resolve mcfly config * fix: too many symlinks * chore: skip tests for now * test: cheating * test: cheating * chore: update pnpm-lock |
||
|---|---|---|
| .. | ||
| event-handler.js | ||
| index.js | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
McFly
McFly is a no-framework framework
that assists in leveraging the web platform
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
✅ Write real .HTML files
✅ Have no frameworks or reactivity libraries on the browser
✅ Use server-side rendering
✅ Deploy anywhere
Special directories
1. ./src/pages/
- file-based routing for
.htmlfiles - 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
.jsfiles for now) - all components are automatically registered using their file names; a
hello-world.jscomponent can be used as<hello-world> - static
.htmlfragments; amy-header.htmlfragment can be directly used as<my-header>
3. ./routes/api/
- file-based routing for REST API endpoints
- e.g.,
./routes/api/users.tscan be accessed viahttp://<domain>/api/users - TypeScript or JavaScript welcome!
McFly config
To tell McFly you want to use components, pass the mode (only "js" for now) to the components prop mcfly.config.ts
import defineConfig from "./packages/define-config";
export default defineConfig({
components: "js",
});
More info
This framework is a result of an exploration for using Nitro and vanilla JS custom elements using a minimal Web Component Base class.
Nitro is the same production-grade web server powering Nuxt
Just keep building
A project by Ayo Ayco