Back to the Basics. Into the Future. https://mcfly.js.org
Find a file
2023-10-24 13:19:59 +02:00
.vscode initial commit 2023-10-07 20:06:23 +02:00
assets chore(templates): update basic template readme 2023-10-21 19:19:09 +02:00
packages feat(create-mcfly): colorize commands 2023-10-23 16:13:27 +02:00
site chore(site, templates): remove config files 2023-10-24 13:07:59 +02:00
templates/basic refactor(templates): make .js api example 2023-10-24 13:15:46 +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 feat(create-mcfly): generate from basic template 2023-10-21 20:25:50 +02:00
.npmrc initial commit 2023-10-07 20:06:23 +02:00
LICENSE feat(create-mcfly): install deps & init git 2023-10-22 17:32:36 +02:00
package-lock.json feat(create-mcfly): colorize commands 2023-10-23 16:13:27 +02:00
package.json chore(packages): add licenses 2023-10-22 18:02:08 +02:00
README.md chore: update readme section for 'routes/api' 2023-10-24 13:19:59 +02:00

rRick & Morty cartoon

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

3. ./routes/api/

  • file-based routing for REST API endpoints
  • e.g., ./routes/api/users.ts can be accessed via http://<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