ayo/mcfly
ayo/mcfly
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Back to the Basics. Into the Future. https://mcfly.js.org
395 commits 1 branch 0 tags 1.9 MiB
JavaScript 66.5%
HTML 16%
TypeScript 15.3%
CSS 2.2%
Find a file
Ayo cd4b341a5f refactor(templates): clean the basic template 
- remove author info
- simplify readme
- clean package info
2024-01-11 21:18:45 +01:00
.vscode style(site): add initial color theme variables 2023-11-09 11:32:41 +01:00
assets chore(templates): update basic template readme 2023-10-21 19:19:09 +02:00
packages chore: bump versions 2023-12-22 05:01:21 +01:00
site feat(site, templates): use new WebComponent.io features 2023-12-11 17:57:21 +01:00
templates/basic refactor(templates): clean the basic template 2024-01-11 21:18:45 +01:00
.eslintignore chore: clean up dot files 2023-10-29 15:33:41 +01:00
.gitignore refactor(templates): clean up basic template 2023-10-29 18:56:43 +01:00
CONTRIBUTING.md chore: fix contributing guide title 2023-11-06 12:28:26 +01:00
LICENSE chore(packages): update LICENSEs 2023-11-09 11:33:02 +01:00
package-lock.json chore: bump versions 2023-12-22 05:01:21 +01:00
package.json chore(core): update WebComonent to v1.13.2 2023-11-23 22:24:33 +01:00
README.md Update README.md 2024-01-06 15:07:37 +01:00

README.md

rRick & Morty cartoon

McFly

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

Project Status

We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases.

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!

Packages

The following are the project packages published on the NPM registry:

Package Description Version
@mcflyjs/cli The McFly CLI tooling npm version
@mcflyjs/config Nitro server config for McFly projects npm version
@mcflyjs/core Route event and config handlers npm version
create-mcfly Script for scaffolding a new McFly workspace npm version

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