KO
|
EN
gitlite — search
Search
#python
#java
#python3
#arduino
#golang
#machine-learning
#rust
#html
#flask
#javascript
#seismology
#nodejs
create
★ 26
Open GitHub ↗
Repository for `npm init @open-wc`
Download README (.md)
Explore Similar Repositories
ECG-GAN
:
Synthesize plausible ECG signals via Generative adversarial networks
Intelligent-vehicle-project
:
No description available.
ComfyJazz
:
Computer-Generated Twitch-Integrated Jazz Music!
pbtetris
:
Tetris for PocketBook 6xx e-readers
mobile_models
:
MLPerf™ Mobile models
// repository documentation
Was this content helpful?
★ 0
(0 ratings)
Select Rating:
★
★
★
★
★
Submit Feedback
Recent Feedback
×
Download README
Do you want to download the
README.md
file for
create
?
Download (.md)
--- permalink: 'init/index.html' title: Create Open Web Components section: guides tags: - guides --- # Create Open Web Components Web component project scaffolding. [//]: # 'AUTO INSERT HEADER PREPUBLISH' ## Usage ```bash npm init @open-wc ``` <div class="custom-block warning"><p class="custom-block-title">WARNING</p> <p><code>npm init</code> requires node 18 & npm 6 or higher</p></div> This will kickstart a menu guiding you through all available actions. $ npm init @open-wc npx: installed 14 in 4.074s _.,,,,,,,,,._ .d'' ``b. Open Web Components Recommendations .p' Open `q. .d' Web Components `b. Start or upgrade your web component project with .d' `b. ease. All our recommendations at your fingertips. :: ................. :: `p. .q' See more details at https://open-wc.org/docs/development/generator/ `p. open-wc.org .q' `b. @openWc .d' `q.. ..,' Note: you can exit any time with Ctrl+C or Esc '',,,,,,,,,,'' ? What would you like to do today? › - Use arrow-keys. Return to submit. ❯ Scaffold a new project Upgrade an existing project Our generators are very modular you can pick and choose as you see fit. ## Options You may pass options to skip the CLI wizard in part or in whole. | Option | Type | Description | | | ----------------------- | ------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | --- | | `--destinationPath` | path | The path the generator will write files to | | | `--type` | `scaffold`\|`upgrade` | Choose scaffold to create a new project or upgrade to add features to an existing project | | | `--scaffoldType` | `wc`\|`app` | The type of project to scaffold. wc for a single published component, app for an application | | | `--features` | `linting`\|`testing`\|`demoing`\|`building` | Which features to include. linting, testing, demoing, or building | | | `--typescript` | `true`\|`false` | Whether to use TypeScript in your project | | | `--tagName` | string | The tag name for the web component or app shell element | | | `--installDependencies` | `yarn`\|`npm`\|`false` | Whether to install dependencies. Choose npm or yarn to install with those package managers, or false to skip installation | | | `--writeToDisk` | `true`\|`false` | Whether or not to actually write the files to disk | | | `--help` | | This help message | | ## Scaffold generators These generators help you kickstart a new app or web component. They will create a new folder and set up everything you need to get started immediately. Example usage: ```bash npm init @open-wc # Select "Scaffold a new project" ``` ### Available scaffold generators: - `Web Component`<br/> This generator scaffolds a starting point for a web component. We recommend using this generator when you want to develop and publish a single web component. <br/> - `Application`<br/> This generator scaffolds a new starter application. We recommend using this generator at the start of your web component project. <br/> ## Features The above generators are the perfect playgrounds to prototype. Add linting, testing, demoing and building whenever the need arises. Example usage: ```bash cd existing-web-component npm init @open-wc # select "Upgrade an existing project" or add features while scaffolding ``` ### Available Upgrade features - `Linting`<br> This generator adds a complete linting setup with ESLint, Prettier, Husky and commitlint. <br/> - `Testing`<br> This generator adds a complete testing setup with Web Test Runner. <br/> - `Demoing`<br> This generator adds a complete demoing setup with Storybook. <br/> - `Building`<br> This generator adds a complete building setup with Rollup. <br/> For information on how to extend and customize the generator, see the [docs page](https://open-wc.org/docs/development/generator/#extending) ## Commands
