create-barelyjs-app
v1.2.1
Published
CLI tool to create a new BarelyJS project
Maintainers
Readme
create-barelyjs-app
create-barelyjs-app is a command-line tool for quickly scaffolding new projects using the BarelyJS library.
Note: This CLI tool works with the BarelyJS library. Check out BarelyJS to see how to build UI components and use the template created by this tool.
Installation
npm install -g create-barelyjs-appOr run it with npx:
npx create-barelyjs-app my-new-appUsage
create-barelyjs-app <app-name> [--js | --jsx | --ts | --tsx]<app-name>— the name of the new project folder.--js— uses a basic JavaScript template.--jsx— uses JSX (Vite) template.--ts— uses a basic TypeScript template with Vite for runtime.--jsx— uses TSX (Vite) template.- The tool will create a folder with this name in your current working directory.
Example:
npx create-barelyjs-app barelyjs-example
npx create-barelyjs-app barelyjs-example --js
npx create-barelyjs-app barelyjs-example --jsx
npx create-barelyjs-app barelyjs-example --ts
npx create-barelyjs-app barelyjs-example --tsxThis will:
- Copy all files from the template folder to
./barelyjs-example. - Update
package.jsonname to"barelyjs-example". - Run
npm installinside the new folder. - Print instructions for starting the project.
After Creation
Once the project is created, you can run:
For JS:
cd <app-name> npx serveFor JSX/TS/TSX:
cd <app-name> npm run dev
This will start a local server serving your new BarelyJS project.
Notes
- Make sure you have Node.js installed (version >=18 recommended).
- The template folder inside this package contains the base structure of a BarelyJS project, including
index.html,src/, andpackage.json. - No build step is required — the template is ready to use immediately.
