16ce0e8 chore: link to contributing on gh pr template
~ayoayco pushed to ~ayoayco/mcfly git
[!NOTE] The project is now on SourceHut. Please submit issues or requests via our Todo Page there, or send them via email. You may also follow updates about the project via our Mailing List.
McFly is a no-framework metaframework
that assists in leveraging the web platform
I often wonder what it would look like to build sites & apps knowing just the basics.
I thought:
McFly is my reimagination of web development: Back to the basics. Into the future.
We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases.
Run the following to generate a McFly starter project.
npm create mcfly@latest
✅ Use vanilla custom elements (or sugar-coated web components)
✅ Write server-powered .html pages
✅ "Use the Platform™" on both server runtimes & browsers
✅ Use server-side rendering
✅ Deploy anywhere, even the Edge
1. ./src/pages/
.html
files<script server:setup>
to define logic that runs on the server, which then gets stripped away2. ./src/components/
.js
files for now)hello-world.js
component can be used as <hello-world>
.html
fragments; a my-header.html
fragment can be directly used as <my-header>
3. ./src/api/
./src/api/users.js
can be accessed via http://<domain>/api/users
The following are the project packages published on the NPM registry:
Package | Description | Version |
---|---|---|
@mcflyjs/config |
Nitro server config for McFly projects | |
@mcflyjs/core |
Route event and config handlers | |
create-mcfly |
Script for scaffolding a new McFly workspace |
After cloning the project, you will need node and pnpm installed. When you are sure that you have node
and pnpm
, then run the following to download the dependencies:
corepack enable
pnpm i
The following commands are available to you on this project. Add more, or modify them as needed in your ./package.json
file.
Command | Action |
---|---|
pnpm run site | Start the development server for https://mcfly.js.org |
pnpm run template:basic | Start the development server for the basic template |
pnpm run build | Locally generate the app's build files to ./output |
pnpm run preview | Preview the built app locally |
This framework is a result of an exploration for using Nitro and 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