mcfly/site
2025-07-05 20:18:51 +02:00
..
src feat(cozy): label example "for form handling" 2025-07-05 20:18:51 +02:00
mcfly.config.mjs feat(config): add plugins in config type 2025-06-27 22:17:24 +02:00
package.json chore(deps): remove unneeded dev dep 2025-04-20 17:16:38 +02:00
README.md chore: housekeeping (#60) 2025-06-07 23:33:58 +02:00
test-plugin.mjs feat(site, template): add api endpoint example 2025-01-08 23:26:56 +01:00
tsconfig.json chore: move app to site 2023-10-21 16:42:17 +02:00

rRick & Morty cartoon

McFly Docs

McFly is a no-framework framework
that assists in building on the Web

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. ./src/api/

  • file-based routing for REST API endpoints
  • e.g., ./src/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',
})

Just keep building
A project by Ayo