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
58 commits 1 branch 0 tags 1.9 MiB
JavaScript 66.5%
HTML 16%
TypeScript 15.3%
CSS 2.2%
Find a file
Ayo 8f68831722 chore: update readme
2023-10-12 20:58:17 +02:00
.vscode initial commit 2023-10-07 20:06:23 +02:00
packages feat: initial packages 2023-10-12 20:38:42 +02:00
plugins feat: initial packages 2023-10-12 20:38:42 +02:00
public use .output dir 2023-10-08 09:35:53 +02:00
routes feat: initial packages 2023-10-12 20:38:42 +02:00
src chore: eslint ignore 2023-10-10 23:50:19 +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 test if no copying 2023-10-08 09:15:10 +02:00
.npmrc initial commit 2023-10-07 20:06:23 +02:00
mcfly.config.ts feat: initial packages 2023-10-12 20:38:42 +02:00
nitro.config.ts feat: replace all matches 2023-10-10 22:20:16 +02:00
package-lock.json initial mcfly config and packages 2023-10-12 19:48:50 +02:00
package.json feat: parseScript to get variables 2023-10-10 22:42:43 +02:00
README.md chore: update readme 2023-10-12 20:58:17 +02:00
tsconfig.json initial mcfly config and packages 2023-10-12 19:48:50 +02:00

README.md

McFly: Back to the Basics. Into the Future.

McFly is a framework that grows with you. Start at the very basic of writing HTML files and enhance with standard web technologies or go advanced as you like, at your own pace.

  • HTML pages
  • Server-Side Rendering logic
  • Custom Elements
  • REST APIs

...all in the same project.

Ambitious Goals

We want a way to:

  1. create web apps with vanilla custom elements
  2. write real .HTML files
  3. no frameworks or reactivity libraries on the browser
  4. server-side pre-rendering
  5. control on when and where JS is downloaded for interactive elements

Special directories

1. src/pages

  • file based routing for .html files
  • directly use custom elements (no registry maintenance needed)

2. src/components

  • custom element constructor class files go here (only .js files for now)
  • all components are automatically registered using their file names (e.g., a hello-world.js component can be used as <hello-world> element)

Setting up

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 run dev
  1. open the browser to https://localhost:3000 (or what the dev server said)

More info

At the moment, this is a Proof of Concept and testing ground for using Nitro and vanilla JS custom elements using a minimal Web Component Base class.

This project was generated from Nitro starter guide. Look at the Nitro documentation to learn more.