@woby/create-woby
v1.0.0
Published
Create Woby apps with no build configuration
Maintainers
Readme
@woby/create-woby
Create Woby apps with no build configuration.
Usage
npm
npm create @woby/create-woby@latest my-apppnpm
pnpm create @woby/create-woby my-appyarn
yarn create @woby/create-woby my-appnpx
npx @woby/create-woby my-appOptions
--template
Select a template to use:
typescript- TypeScript template (default)javascript- JavaScript template
# Create a TypeScript app (default)
pnpm dlx @woby/create-woby my-app
# Create a JavaScript app
pnpm create @woby/create-woby my-app --template javascriptWhat's Included?
- Woby framework
- Vite for development and building
- TypeScript support (in TypeScript template)
- Basic counter example to get started
Project Structure
TypeScript Template
my-woby-app/
├── src/
│ ├── App.tsx
│ └── main.ts
├── index.html
├── tsconfig.json
├── vite.config.js
└── package.jsonJavaScript Template
my-woby-app/
├── src/
│ ├── App.jsx
│ └── main.js
├── index.html
├── vite.config.js
└── package.jsonGetting Started
Create a new project:
pnpm dlx @woby/create-woby my-appNavigate to the project directory:
cd my-appInstall dependencies:
pnpm installStart the development server:
pnpm run devBuild for production:
pnpm run build
Development
Available Scripts
pnpm run dev- Starts the development serverpnpm run build- Builds the app for productionpnpm run preview- Previews the production build locally
Learn More
To learn more about Woby, check out the official website.
License
MIT
