Back to the Basics. Into the Future. https://mcfly.js.org
Find a file
2023-10-21 19:08:21 +02:00
.vscode initial commit 2023-10-07 20:06:23 +02:00
assets feat(templates): change basic template screenshot 2023-10-21 18:31:57 +02:00
packages refactor: delete remaining .ts files 😱 2023-10-21 17:59:32 +02:00
site perf(site): remove unneeded resources 2023-10-21 18:09:40 +02:00
templates/basic fix(templates): commands in readme 2023-10-21 19:08:21 +02:00
.editorconfig initial commit 2023-10-07 20:06:23 +02:00
.eslintignore initial commit 2023-10-07 20:06:23 +02:00
.eslintrc initial commit 2023-10-07 20:06:23 +02:00
.gitignore chore: update content; ignore temp files 2023-10-16 09:26:57 +02:00
.npmrc initial commit 2023-10-07 20:06:23 +02:00
package-lock.json chore(chore): update versions 2023-10-21 17:37:50 +02:00
package.json chore: move app to site 2023-10-21 16:42:17 +02:00
README.md chore: update landing-page and readme links 2023-10-21 16:43:15 +02:00
tsconfig.json initial mcfly config and packages 2023-10-12 19:48:50 +02:00

rRick & Morty cartoon

McFly

McFly is a no-framework framework
that assists in leveraging the web platform

Features

  • 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 .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>

Setting up

In this project, we maintain several node workspaces in directories ./packages, ./site, and ./templates.

You can experience the framework now by cloning the project and playing with the example files in the special directories for the landing page (./site/src).

Do the following steps to get you started:

  1. clone project and go into the directory
git clone https://github.com/ayoayco/mcfly.git
cd mcfly
  1. install deps
npm i
  1. run the dev server
npm start
  1. open the browser to https://localhost:3000 (or what the dev server said)

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