ayo/mcfly
ayo/mcfly
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: update readme section for 'routes/api'

Browse source
This commit is contained in:
Ayo 2023-10-24 13:19:59 +02:00
parent 26c7241790
commit 4b46f4aaa1
1 changed files with 8 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -29,16 +29,21 @@ The time has come for vanilla Web tech. 🎉
✅ Deploy anywhere<br> ✅ Deploy anywhere<br>
## Special directories ## Special directories
**1. `src/pages`** **1. `./src/pages/`**
- file based routing for `.html` files - file-based routing for `.html` files
- directly use custom elements & static fragments (no imports or registry maintenance needed) - 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 - use `<script server:setup>` to define logic that runs on the server, which then gets stripped away
**2. `src/components`** **2. `./src/components/`**
- custom element constructor files (only `.js` files for now) - 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>` - 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>` - 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!
## McFly config ## McFly config
To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts