NPM-README.md

<p align="center">
  <a href="https://opentemplatehub.com">
    <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/generator/server-generator-logo.png" alt="Logo" width=200>
  </a>
</p>

<h1 align="center">
Open Template Hub - UI Generator v5
</h1>

[![GitHubRepo](https://img.shields.io/badge/GitHub-Repository-24292e.svg?style=for-the-badge&logo=github)](https://github.com/open-template-hub/app-generator)
[![SonarCloud](https://img.shields.io/sonar/quality_gate/open-template-hub_app-generator?server=https%3A%2F%2Fsonarcloud.io&label=Sonar%20Cloud&style=for-the-badge&logo=sonarcloud)](https://sonarcloud.io/dashboard?id=open-template-hub_app-generator)

Command-line interface generator of the servers at [Open Template Hub](https://github.com/open-template-hub)

Available UI types are:

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/open-template-hub/web-ui-template">
        <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/ui/web-ui-logo.png" width="100px;" alt=""/>
        <br />
        <sub>
          <b>
            Web UI
          </b>
        </sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/open-template-hub/mobile-ui-template">
        <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/ui/mobile-ui-logo.png" width="100px;" alt=""/>
        <br />
        <sub>
          <b>
            Mobile UI
          </b>
        </sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/open-template-hub/company-profile-ui-template">
        <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/ui/web-ui-logo.png" width="100px;" alt=""/>
        <br />
        <sub>
          <b>
            Company Profile UI
          </b>
        </sub>
      </a>
    </td>
    <td align="center">
      <a href="https://github.com/open-template-hub/admin-ui-template">
        <img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/ui/admin-ui-logo.png" width="100px;" alt=""/>
        <br />
        <sub>
          <b>
            Admin UI
          </b>
        </sub>
      </a>
    </td>
  </tr>
</table>

## About the NPM Package

### Package Installation

```sh
npm install -g @open-template-hub/app-generator
```

### Package Usage

Go to the directory on terminal where you want to generate the project.

```sh
$ cd PATH
```

and run the generator command:

```sh
$ open-template-hub-app-generator
```

# Sponsors

No sponsors yet! **Will you be the first?**

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/furknyavuz"><img src="https://avatars0.githubusercontent.com/u/2248168?s=460&u=435ef6ade0785a7a135ce56cae751fb3ade1d126&v=4" width="100px;" alt=""/><br /><sub><b>Furkan Yavuz</b></sub></a><br /><a href="https://github.com/open-template-hub/app-generator/issues/created_by/furknyavuz" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/app-generator/commits?author=furknyavuz" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/app-generator/pulls?q=is%3Apr+reviewed-by%3Afurknyavuz" title="Reviewed Pull Requests">👀</a></td>
    <td align="center"><a href="https://github.com/fatihturker"><img src="https://avatars1.githubusercontent.com/u/2202179?s=460&u=261b1129e7106c067783cb022ab9999aad833bdc&v=4" width="100px;" alt=""/><br /><sub><b>Fatih Turker</b></sub></a><br /><a href="https://github.com/open-template-hub/app-generator/issues/created_by/fatihturker" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/app-generator/commits?author=fatihturker" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/app-generator/pulls?q=is%3Apr+reviewed-by%3Afatihturker" title="Reviewed Pull Requests">👀</a></td>
    <td align="center"><a href="https://github.com/mertlsarac"><img src="https://avatars1.githubusercontent.com/u/38442589?s=400&u=aa3cda11724fc297a0bfa6beb35c9be81687cf3c&v=4" width="100px;" alt=""/><br /><sub><b>Mert Sarac</b></sub></a><br /><a href="https://github.com/open-template-hub/app-generator/issues/created_by/mertlsarac" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/app-generator/commits?author=mertlsarac" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/app-generator/pulls?q=is%3Apr+reviewed-by%3Amertlsarac" title="Reviewed Pull Requests">👀</a></td>
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

## Contributing

Refer to **[CONTRIBUTING.md](https://github.com/open-template-hub/.github/blob/master/docs/CONTRIBUTING.md)** to see how to contribute to Open Template Hub.

<br/>

## Code of Conduct

Refer to **[CODE_OF_CONDUCT.md](https://github.com/open-template-hub/.github/blob/master/docs/CODE_OF_CONDUCT.md)** to see contributor covenant code of conduct.

<br/>

## LICENSE

The source code for this project is released under the [MIT License](LICENSE).