create-karton-app
Version:
Create KartonJS Application in one command.
81 lines (47 loc) • 1.57 kB
Markdown
# create-karton-app
> Scaffold a new [KartonJS](https://gitlab.com/rodezee/kartonjs) app with a single command.
## What is this?
`create-karton-app` is a CLI tool that quickly generates a minimal starter project for [KartonJS](https://gitlab.com/rodezee/kartonjs), a lightweight web component framework.
It creates a ready-to-run project with the essential files and dependencies so you can jump straight into developing your KartonJS app.
## Installation & Usage
You can run it directly with [npx](https://www.npmjs.com/package/npx), no global install required:
```bash
npx create-karton-app my-app
```
This will:
Create a new folder my-app
Scaffold a KartonJS hello world app inside
Install dependencies (kartonjs, uhtml, vite, etc.)
Provide you with scripts to start and build your app
## Manual usage
If you have the repository cloned or the script locally, run:
```bash
node create-karton-app.js my-app
```
Make sure to replace my-app with your desired project name.
After creation
## Navigate to your new project folder:
```bash
cd my-app
npm start
```
Open http://localhost:3000 in your browser to see your KartonJS app running!
Requirements
Node.js v14+ (for ESM and fs/promises support)
npm
## License
MIT © Your Name
## Contributing
Feel free to submit issues and pull requests to improve this scaffolding tool!
## Contact
For KartonJS-related questions, visit [your project repo URL].
Just let me know if you want it as a file or need anything else!
# create-karton-app