Skip to content

Commit 802f083

Browse files
authored
docs(create-app): document community templates (#643)
* docs(create-app): document community templates * chore: refresh pnpm lockfile * docs(create-app): refine community templates documentation * docs(create-app): streamline community template promotion instructions
1 parent d75ae45 commit 802f083

2 files changed

Lines changed: 40 additions & 17 deletions

File tree

docs/commands/create-app.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,28 @@ You can run `pnpm create @dhis2/app@alpha --help` for the list of options availa
4848
--packagemanager [string]
4949
```
5050

51+
## Community templates
52+
53+
The CLI also supports installing templates developed by the community using a GitHub repository URL or `owner/repo` specifier. These templates are maintained outside the CLI, so you should review the source code before using them in your project.
54+
55+
Here are some of the available community templates:
56+
57+
### Tailwind + React Router
58+
59+
React Router DHIS2 app template with Tailwind CSS.
60+
61+
Repository: [https://github.com/derrick-nuby/dhis2-ts-tailwind-react-router](https://github.com/derrick-nuby/dhis2-ts-tailwind-react-router)
62+
63+
```sh
64+
pnpm create @dhis2/app my-app --template https://github.com/derrick-nuby/dhis2-ts-tailwind-react-router
65+
```
66+
67+
Main components: Tailwind CSS, React Router
68+
Organisation: HISP Rwanda
69+
Developed by: [Derrick Iradukunda](https://github.com/derrick-nuby)
70+
71+
If you would like to promote your own community template, you can open a PR for the [CLI docs](https://github.com/dhis2/cli/blob/master/docs/commands/create-app.md) including template URL and installation steps, and any other relevant information.
72+
5173
## Examples
5274

5375
Here are some examples of how you can use the CLI

pnpm-lock.yaml

Lines changed: 18 additions & 17 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)