You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: introduction.md
+19-19Lines changed: 19 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -108,12 +108,12 @@ The easiest and straight-forward way to create your customized template is to cl
108
108
109
109
Here is the list of the six main blank templates depending on the coding language preferences.
110
110
111
-
- Plain JavaScript template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank)
112
-
- TypeScript template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ts](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ts)
113
-
- Angular template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ng](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-ng)
114
-
- Vue.js template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-vue](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-vue)
115
-
- React template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-react](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-react)
116
-
- Svelte template at [https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-svelte](https://github.com/NativeScript/nativescript-app-templates/tree/master/packages/template-blank-svelte)
Creating your template is as simple as cloning the wanted template repository and modifying the source code to satisfy your business logic.
119
119
@@ -130,15 +130,9 @@ ns run android
130
130
// start making code changes
131
131
```
132
132
133
-
## Versioning Scheme
134
-
135
-
`@nativescript/core` does not follow Semantic Versioning. Major framework releases are released every six months (~March and ~September), while minor and patch releases may be released as often as every week. Patch releases should never contain breaking changes, however minor, and major releases can. We strive to note any breaking changes in the Changelogs, to make upgrades as easy as possible.
136
-
137
-
When referencing the `@nativescript/core` package, you should use a fixed version constraint such as `7.0.11`, or alternatively `~7.0.11` to allow installing patch updates.
138
-
139
-
## Guidelines
133
+
#### Guidelines
140
134
141
-
### Template Structure Guidelines
135
+
#####Template Structure Guidelines
142
136
143
137
- Create folders named for the feature area they represent. Each featured area should be placed in a separate folder in the template's folder structure.
144
138
@@ -148,7 +142,7 @@ When referencing the `@nativescript/core` package, you should use a fixed versio
148
142
149
143
- Avoid putting all of your app template's code in a root folder named _app_. When the actual app is created from the template, all of the template's code will indeed go inside a root **app** folder, but you MUST NOT define this folder in the hierarchy of your template; otherwise, the `ns create` CLI command will not function properly.
150
144
151
-
### Package.json Guidelines
145
+
#####Package.json Guidelines
152
146
153
147
- Place a `package.json` file in the root folder of your app template.
154
148
Note this is not the actual root package.json of the generated mobile app – it is only used by the `ns create` CLI command upon app creation. Do not expect that everything you place in your package.json will be transferred to the actual package.json file. Notably `scripts` property content is removed. However, if you provide preinstall / postinstall scripts, they will be executed before getting removed. You can use this mechanism to generate/move settings files to the root folder of the generated app and generate actual "scripts" content for the resulting app package.json – see [copying settings files](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/preinstall.js) and [generating `scripts` commands on-the-fly](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/postinstall.js) for concrete examples.
@@ -208,18 +202,18 @@ When referencing the `@nativescript/core` package, you should use a fixed versio
208
202
-`category-general` - will show the template under the "General" tab in the ["Templates" page](https://market.nativescript.org/?tab=templates). This is the general or basic category, used to describe "generic" functionality.
209
203
-`category-healthcare` - will show the template under the "Healthcare" tab in the ["Templates" page](https://market.nativescript.org/?tab=templates). This is a special category, used to describe a template with functionality related to the healthcare industry.
210
204
211
-
### Marketplace Guidelines
205
+
#####Marketplace Guidelines
212
206
213
207
- Publish your app template to npm (https://www.npmjs.com/) using **ns-template-[custom-template-name-goes-here]-ts** format for the npm package name.
214
208
215
209
- Provide a screenshot preview to be used in a future NativeScript Marketplace integration under **tools/assets/marketplace.png** in your app template folder structure.
216
-
Check [tools/postinstall.js](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/postinstall.js) that implements a mechanism for removing the "tools" infrastructure folder from the generated app.
210
+
Check [tools/postinstall.js[NOT FOUND]](https://github.com/NativeScript/template-master-detail-ts/blob/master/tools/postinstall.js) that implements a mechanism for removing the "tools" infrastructure folder from the generated app.
217
211
218
212
- Provide correct `repository` property value in the root package.json file of your app template (see the "Package.json guidelines" section above for additional package.json requirements).
219
213
220
214
-[Read more](https://github.com/NativeScript/marketplace-feedback/blob/master/docs/template-submission.md) how to submit your app template to [NativeScript Marketplace](https://market.nativescript.org).
221
215
222
-
### Styling Guidelines
216
+
#####Styling Guidelines
223
217
224
218
- Consider using the [NativeScript core theme](https://github.com/NativeScript/theme) for styling your app template.
225
219
@@ -347,8 +341,14 @@ NavigationButton {
347
341
/* Place any CSS rules you want to apply only on iOS here */
`@nativescript/core` does not follow Semantic Versioning. Major framework releases are released every six months (~March and ~September), while minor and patch releases may be released as often as every week. Patch releases should never contain breaking changes, however minor, and major releases can. We strive to note any breaking changes in the Changelogs, to make upgrades as easy as possible.
353
+
354
+
When referencing the `@nativescript/core` package, you should use a fixed version constraint such as `7.0.11`, or alternatively `~7.0.11` to allow installing patch updates.
0 commit comments