Skip to content

Commit 7b40e4b

Browse files
committed
docs: add README
1 parent d091055 commit 7b40e4b

File tree

2 files changed

+25
-1
lines changed

2 files changed

+25
-1
lines changed

packages/create-app/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# @dhis2/create-app
2+
3+
This package publishes a package that follows the convention of [npm create](https://docs.npmjs.com/cli/v11/commands/npm-init#synopsis).
4+
5+
This allows users to create a new DHIS2 web application by running the command:
6+
7+
```sh
8+
# with pnpm
9+
pnpm create @dhis2/app project-name --yes
10+
#
11+
```
12+
13+
```sh
14+
# with npm
15+
npm create @dhis2/app -- --yes
16+
# or npx @dhis2/create-app --yes
17+
```
18+
19+
By passing `--yes` argument, this will create a new DHIS2 web application using the default options without prompting (using `pnpm` as a package manager, and `TypeScript` as the language).
20+
21+
If you omit the `--yes` argument `pnpm create @dhis2/app project-name` then you will be prompted and guided through a wizard to choose your options.
22+
23+
You can run the commands in `debug` mode to get more verbose logs by passing the `--debug` option (`pnpm create @dhis2/app project-name --debug`).

pnpm-lock.yaml

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)