create-knuddels-userapp

A command line tool to easily setup a Knuddels UserApp with TypeScript and React (similar to create-react-app).

Usage

Simply run it via npx, no installation required: Open a terminal inside the directory that should contain the root folder of your UserApp and run

npx create-knuddels-userapp MyUserApp

This will create a new folder with files and sub folders. Done! You can now open this folder in your favorite IDE. From within, run

npm run build-all

Upload the generated content from within the dist folder to a folder on your Knuddels FTP server with the same name as your UserApp. (For example, if you used the example command from above, you should copy the contents of MyUserApp/dist/ (on your local computer) to ftp/MyUserApp/ on your Knuddels FTP server.)

Command Syntax

npx create-knuddels-userapp <location> [options]

Arguments:

• <location> (required): Root folder of the app, will be created (relative to current location or absolute).

Options:

• -t, --title <title> Set a different name for your UserApp. Will appear in app.config. Default is last part of location.
• --noReact: Don't add React support.
• -v, --version: Output the current version.
• -h, --help: Display help for command.

Important: Insert -- into your command before you use options! Otherwise, npx won't pass them to the script. Example:

npx create-knuddels-userapp ./projects/my-userapp -- --noReact --title MyUserApp

Troubleshooting

• Make sure that you have the latest version of Node.js installed.