chore: update readme files with correct api path

README.md

@@ -62,7 +62,7 @@ npm create mcfly@latest
 **3. `./src/api/`**
 
 - file-based routing for REST API endpoints
-- e.g., `./routes/api/users.js` can be accessed via `http://<domain>/api/users`
+- e.g., `./src/api/users.js` can be accessed via `http://<domain>/api/users`
 - TypeScript or JavaScript welcome!
 
 ## Packages
@@ -75,6 +75,24 @@ The following are the project packages published on the NPM registry:
 | [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core)     | Route event and config handlers              | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore)   |
 | [`create-mcfly`](https://ayco.io/n/create-mcfly)       | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly)        |
 
+## Project setup
+
+After cloning the project, you will need [node](https://nodejs.org/en/download) and [pnpm installed](https://pnpm.io/installation). 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                         |
+
 ## More info
 
 This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [Nitro](https://nitro.build) and custom elements using a minimal [Web Component Base](https://WebComponent.io) class.

packages/config/README.md

@@ -17,6 +17,7 @@
 I often wonder what it would look like to build sites & apps knowing just the basics.
 
 I thought:
+
 - What if I knew how to write HTML and I can have a dynamic web page from that?
 - What if I knew how to build custom elements and that's all the component system I needed?
 - What if I can write HTML fragments and assemble them easily in a page?
@@ -25,10 +26,13 @@ I thought:
 **McFly** is my reimagination of web development: Back to the basics. Into the future.
 
 ## Project Status
+
 We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases.
 
 ## Try it today
+
 Run the following to generate a McFly starter project.
+
 ```
 npm create mcfly@latest
 ```
@@ -42,36 +46,43 @@ npm create mcfly@latest
 ✅ Deploy anywhere, even the Edge<br>
 
 ## 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. `./routes/api/`**
+**3. `./src/api/`**
+
 - file-based routing for REST API endpoints
-- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/api/users`
+- e.g., `./src/api/users.ts` can be accessed via `http://<domain>/api/users`
 - TypeScript or JavaScript welcome!
 
 ## Packages
+
 The following are the project packages published on the NPM registry:
 
-| Package | Description | Version |
+| Package                                                | Description                                  | Version                                                          |
-| --- | --- | --- |
+| ------------------------------------------------------ | -------------------------------------------- | ---------------------------------------------------------------- |
-| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli) | The McFly CLI tooling | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli) |
+| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli)       | The McFly CLI tooling                        | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli)    |
-| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) |
+| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects       | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) |
-| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Route event and config handlers | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore) |
+| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core)     | Route event and config handlers              | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore)   |
-| [`create-mcfly`](https://ayco.io/n/create-mcfly) | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly) |
+| [`create-mcfly`](https://ayco.io/n/create-mcfly)       | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly)        |
 
 ## More info
+
 This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [Nitro](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [Web Component Base](https://WebComponent.io) class.
 
 **Nitro** is the same production-grade web server powering [Nuxt](https://nuxt.com/)
 
 ---
-*Just keep building*<br />
+
-*A project by [Ayo Ayco](https://ayco.io)*
+_Just keep building_<br />
+_A project by [Ayo Ayco](https://ayco.io)_

packages/core/README.md

@@ -17,6 +17,7 @@
 I often wonder what it would look like to build sites & apps knowing just the basics.
 
 I thought:
+
 - What if I knew how to write HTML and I can have a dynamic web page from that?
 - What if I knew how to build custom elements and that's all the component system I needed?
 - What if I can write HTML fragments and assemble them easily in a page?
@@ -25,10 +26,13 @@ I thought:
 **McFly** is my reimagination of web development: Back to the basics. Into the future.
 
 ## Project Status
+
 We are currently in a Proof of Concept phase. All parts are subject to breaking changes in minor releases.
 
 ## Try it today
+
 Run the following to generate a McFly starter project.
+
 ```
 npm create mcfly@latest
 ```
@@ -42,36 +46,43 @@ npm create mcfly@latest
 ✅ Deploy anywhere, even the Edge<br>
 
 ## 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. `./routes/api/`**
+**3. `./src/api/`**
+
 - file-based routing for REST API endpoints
-- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/api/users`
+- e.g., `./src/api/users.ts` can be accessed via `http://<domain>/api/users`
 - TypeScript or JavaScript welcome!
 
 ## Packages
+
 The following are the project packages published on the NPM registry:
 
-| Package | Description | Version |
+| Package                                                | Description                                  | Version                                                          |
-| --- | --- | --- |
+| ------------------------------------------------------ | -------------------------------------------- | ---------------------------------------------------------------- |
-| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli) | The McFly CLI tooling | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli) |
+| [`@mcflyjs/cli`](https://ayco.io/n/@mcflyjs/cli)       | The McFly CLI tooling                        | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcli)    |
-| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) |
+| [`@mcflyjs/config`](https://ayco.io/n/@mcflyjs/config) | Nitro server config for McFly projects       | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fconfig) |
-| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core) | Route event and config handlers | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore) |
+| [`@mcflyjs/core`](https://ayco.io/n/@mcflyjs/core)     | Route event and config handlers              | ![npm version](https://img.shields.io/npm/v/%40mcflyjs%2Fcore)   |
-| [`create-mcfly`](https://ayco.io/n/create-mcfly) | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly) |
+| [`create-mcfly`](https://ayco.io/n/create-mcfly)       | Script for scaffolding a new McFly workspace | ![npm version](https://img.shields.io/npm/v/create-mcfly)        |
 
 ## More info
+
 This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [Nitro](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [Web Component Base](https://WebComponent.io) class.
 
 **Nitro** is the same production-grade web server powering [Nuxt](https://nuxt.com/)
 
 ---
-*Just keep building*<br />
+
-*A project by [Ayo Ayco](https://ayco.io)*
+_Just keep building_<br />
+_A project by [Ayo Ayco](https://ayco.io)_

packages/create-mcfly/README.md

@@ -17,6 +17,7 @@ npm create mcfly@latest
 </p>
 
 ## Features
+
 The time has come for vanilla Web tech. 🎉
 
 ✅ Create web apps with vanilla custom elements<br>
@@ -26,19 +27,23 @@ The time has come for vanilla Web tech. 🎉
 ✅ Deploy anywhere<br>
 
 ## 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. `./routes/api/`**
+**3. `./src/api/`**
+
 - file-based routing for REST API endpoints
-- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/api/users`
+- e.g., `./src/api/users.ts` can be accessed via `http://<domain>/api/users`
 - TypeScript or JavaScript welcome!
 
 ## McFly config
@@ -46,19 +51,20 @@ The time has come for vanilla Web tech. 🎉
 To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts
 
 ```js
-import defineConfig from "./packages/define-config";
+import defineConfig from './packages/define-config'
 
 export default defineConfig({
-  components: "js",
+  components: 'js',
-});
+})
-
 ```
 
 ## More info
+
 This framework is a result of [an exploration](https://social.ayco.io/@ayo/111195315785886977) for using [**Nitro**](https://nitro.unjs.io) and vanilla JS custom elements using a minimal [**Web Component Base**](https://WebComponent.io) class.
 
 **Nitro** is the same production-grade web server powering [**Nuxt**](https://nuxt.com/)
 
 ---
-*Just keep building*<br />
+
-*A project by [Ayo Ayco](https://ayco.io)*
+_Just keep building_<br />
+_A project by [Ayo Ayco](https://ayco.io)_

site/README.md

@@ -13,19 +13,23 @@
 </p>
 
 ## 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. `./routes/api/`**
+**3. `./src/api/`**
+
 - file-based routing for REST API endpoints
-- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/api/users`
+- e.g., `./src/api/users.ts` can be accessed via `http://<domain>/api/users`
 - TypeScript or JavaScript welcome!
 
 ## McFly config
@@ -33,14 +37,14 @@
 To tell McFly you want to use components, pass the mode (only `"js"` for now) to the `components` prop mcfly.config.ts
 
 ```js
-import defineConfig from "./packages/define-config";
+import defineConfig from './packages/define-config'
 
 export default defineConfig({
-  components: "js",
+  components: 'js',
-});
+})
-
 ```
 
 ---
-*Just keep building*<br />
+
-*A project by [Ayo Ayco](https://ayco.io)*
+_Just keep building_<br />
+_A project by [Ayo Ayco](https://ayco.io)_

templates/basic/README.md

@@ -5,28 +5,32 @@ This project was generated from the basic template for **McFly** -- a no-framewo
 It contains example files to get you started using vanilla web technologies in a modern way. See the [Special Directories](#special-directories) section for more information.
 
 ## 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. `./routes/api/`**
+**3. `./src/api/`**
+
 - file-based routing for REST API endpoints
-- e.g., `./routes/api/users.ts` can be accessed via `http://<domain>/api/users`
+- e.g., `./src/api/users.ts` can be accessed via `http://<domain>/api/users`
 - TypeScript or JavaScript welcome!
 
 ## Commands
 
 The following commands are available to you on this project. Add more, or modify them as needed in your `./package.json` file.
 
-| Command | Action |
+| Command         | Action                                               |
-| --- | --- |
+| --------------- | ---------------------------------------------------- |
-| npm start | Start the development server |
+| npm run dev     | Start the development server                         |
-| npm run prepare | Prepare the workspace |
+| npm run prepare | Prepare the workspace                                |
-| npm run build | Locally generate the app's build files to `./output` |
+| npm run build   | Locally generate the app's build files to `./output` |
-| npm run preview | Preview the built app locally |
+| npm run preview | Preview the built app locally                        |