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

refactor(templates): clean the basic template

Browse source 
- remove author info
- simplify readme
- clean package info
This commit is contained in:
Ayo 2024-01-11 21:18:45 +01:00
parent 12b2066057
commit cd4b341a5f
3 changed files with 2 additions and 41 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
templates/basic/README.md
View file

@ -1,23 +1,9 @@
# McFly Starter Project
## Background
This project was generated from the basic template for **McFly** -- a no-framework framework that assists in leveraging the web platform.
![template-basic](https://raw.githubusercontent.com/ayoayco/McFly/main/assets/template-basic.png)
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.
## Features
The time has come for vanilla Web tech. 🎉
✅ Create web apps with vanilla custom elements<br>
✅ Write real .HTML files<br>
✅ Have no frameworks or reactivity libraries on the browser<br>
✅ Use server-side rendering<br>
✅ Deploy anywhere<br>
## Special directories
**1. `./src/pages/`**
- file-based routing for `.html` files
@ -34,18 +20,6 @@ The time has come for vanilla Web tech. 🎉
- e.g., `./routes/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
```js
import defineConfig from "./packages/define-config";
export default defineConfig({
components: "js",
});
```
## Commands
The following commands are available to you on this project. Add more, or modify them as needed in your `./package.json` file.
@ -56,8 +30,3 @@ The following commands are available to you on this project. Add more, or modify
| npm run prepare | Prepare the workspace |
| npm run build | Locally generate the app's build files to `./output` |
| npm run preview | Preview the built app locally |
---
*Just keep building*<br />
*A project by [Ayo Ayco](https://ayco.io)*

8
templates/basic/package.json
View file

@ -1,6 +1,6 @@
{
"name": "@templates/basic",
"description": "McFly starter project; see more on https://ayco.io/gh/McFly",
"description": "McFly starter project",
"scripts": {
"start": "mcfly serve",
"prepare": "mcfly prepare",
@ -14,9 +14,5 @@
"@mcflyjs/config": "latest",
"@mcflyjs/core": "latest",
"nitropack": "latest"
},
"version": "0.0.1",
"main": "index.js",
"author": "Ayo Ayco",
"license": "MIT"
}
}

4
templates/basic/src/pages/index.html
View file

@ -11,10 +11,6 @@
name: "McFly",
description: "Back to the Basics. Into the Future."
};
const author = {
name: "Ayo Ayco",
url: "https://ayco.io"
}
</script>
</my-head>
<body>