Skip to content

README.md

Latest commit

 

History

History
121 lines (87 loc) · 1.82 KB

README.md

File metadata and controls

121 lines (87 loc) · 1.82 KB

@woby/create-woby

Create Woby apps with no build configuration.

Usage

npm

npm create @woby/create-woby@latest my-app

pnpm

pnpm create @woby/create-woby my-app

yarn

yarn create @woby/create-woby my-app

npx

npx @woby/create-woby my-app

Options

--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 javascript

What'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.json

JavaScript Template

my-woby-app/
├── src/
│   ├── App.jsx
│   └── main.js
├── index.html
├── vite.config.js
└── package.json

Getting Started

  1. Create a new project:

    pnpm dlx @woby/create-woby my-app

  2. Navigate to the project directory:

    cd my-app

  3. Install dependencies:

    pnpm install

  4. Start the development server:

    pnpm run dev

  5. Build for production:

    pnpm run build

Development

Available Scripts

  • pnpm run dev - Starts the development server
  • pnpm run build - Builds the app for production
  • pnpm run preview - Previews the production build locally

Learn More

To learn more about Woby, check out the official website.

License

MIT