-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding README file for Web Components projects (#1041)
- Loading branch information
Showing
1 changed file
with
39 additions
and
0 deletions.
There are no files selected for viewing
39 changes: 39 additions & 0 deletions
39
packages/cli/templates/webcomponents/igc-ts/projects/_base/files/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# $(dashName) | ||
|
||
This project was generated with [Ignite UI CLI](https://github.com/IgniteUI/igniteui-cli) version $(cliVersion). | ||
|
||
## Development server | ||
|
||
Run `ig start` to build the application, start a web server and open the application in the default browser. Then navigate to `http://localhost:8000/`. Default serving port can be configured in `ignite-ui-cli.json` via `defaultPort` property. | ||
|
||
## Build | ||
|
||
Run `ig build` to build the application into an output directory. | ||
|
||
## Step by step mode | ||
|
||
If you want to get a guided experience through the available options, you can initialize the step by step mode that will help you to create and setup your new application, as well as update project previously created with the Ignite UI CLI. To start the guide, simply run the `ig` command. | ||
|
||
## List templates | ||
|
||
The `ig list` lists all available templates. When you run the command within a project folder it will list all available templates, even if you have provided different ones. | ||
|
||
## Adding components | ||
|
||
Add a new component or template to the project passing component ID and choosing a name. | ||
|
||
`ig add <component/template> <component_name>` | ||
|
||
The ID matches either a component ("grid", "dropdown", etc) or a predefined template. Predefined templates can provide either multiple components or fulfilling a specific use case like "subscription-form". | ||
|
||
## Running unit tests | ||
|
||
Run `ig test` to execute the unit tests via [@web/test-runner](https://modern-web.dev/docs/test-runner/overview). Runs all `.test.ts` files. | ||
|
||
## Help | ||
|
||
`ig help` lists the available commands and provides a brief description of what they do. | ||
|
||
### Further help | ||
|
||
To get more help on the IgniteUI CLI go check out the [IgniteUI CLI Wiki](https://github.com/IgniteUI/igniteui-cli/wiki). |