mcfly/templates/basic/README.md

1,017 B

McFly Starter Project

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

npm create mcfly@latest

template-basic

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>