-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md
165 lines (139 loc) · 7.71 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
<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 - Server Generator v5
</h1>
[![Version](https://img.shields.io/npm/v/@open-template-hub/server-generator?color=CB3837&style=for-the-badge&logo=npm)](https://www.npmjs.com/package/@open-template-hub/server-generator)
[![Downloads](https://img.shields.io/npm/dt/@open-template-hub/server-generator?color=CB3837&logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@open-template-hub/server-generator)
[![License](https://img.shields.io/github/license/open-template-hub/server-generator?color=43b043&style=for-the-badge)](LICENSE)
[![Issues](https://img.shields.io/github/issues/open-template-hub/server-generator?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/server-generator/issues)
[![PRCLosed](https://img.shields.io/github/issues-pr-closed-raw/open-template-hub/server-generator?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/server-generator/pulls?q=is%3Apr+is%3Aclosed)
[![LastCommit](https://img.shields.io/github/last-commit/open-template-hub/server-generator?color=43b043&style=for-the-badge)](https://github.com/open-template-hub/server-generator/commits/master)
[![Release](https://img.shields.io/github/release/open-template-hub/server-generator?include_prereleases&color=43b043&style=for-the-badge)](https://github.com/open-template-hub/server-generator/releases)
[![SonarCloud](https://img.shields.io/sonar/quality_gate/open-template-hub_server-generator?server=https%3A%2F%2Fsonarcloud.io&label=Sonar%20Cloud&style=for-the-badge&logo=sonarcloud)](https://sonarcloud.io/dashboard?id=open-template-hub_server-generator)
Command-line interface generator of the servers at [Open Template Hub](https://github.com/open-template-hub)
Available server types are:
<table>
<tr>
<td align="center">
<a href="https://github.com/open-template-hub/auth-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/auth-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
Auth Server
</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/open-template-hub/payment-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/payment-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
Payment Server
</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/open-template-hub/file-storage-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/file-storage-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
File Storage Server
</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/open-template-hub/business-logic-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/business-logic-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
Business Logic Server
</b>
</sub>
</a>
</td>
</tr>
<tr>
<td align="center">
<a href="https://github.com/open-template-hub/analytics-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/analytics-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
Analytics Server
</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/open-template-hub/mail-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/mail-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
Mail Server
</b>
</sub>
</a>
</td>
<td align="center">
<a href="https://github.com/open-template-hub/sms-server-template">
<img src="https://raw.githubusercontent.com/open-template-hub/open-template-hub.github.io/master/assets/logo/server/sms-server-logo.png" width="100px;" alt=""/>
<br />
<sub>
<b>
SMS Server
</b>
</sub>
</a>
</td>
</tr>
</table>
## About the NPM Package
### Package Installation
```sh
npm install -g @open-template-hub/server-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-server-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/server-generator/issues/created_by/furknyavuz" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/server-generator/commits?author=furknyavuz" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/server-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/server-generator/issues/created_by/fatihturker" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/server-generator/commits?author=fatihturker" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/server-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/server-generator/issues/created_by/mertlsarac" title="Answering Questions">💬</a> <a href="https://github.com/open-template-hub/server-generator/commits?author=mertlsarac" title="Documentation">📖</a> <a href="https://github.com/open-template-hub/server-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).