From 66f17ee75a64fe80e61c940b7d8350b05be92d7b Mon Sep 17 00:00:00 2001 From: mkucharz Date: Wed, 27 Dec 2017 15:46:04 +0100 Subject: [PATCH] fix(docs): missing file --- .../web/deployment/create-project-template.md | 40 +++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 docs/cookbook/web/deployment/create-project-template.md diff --git a/docs/cookbook/web/deployment/create-project-template.md b/docs/cookbook/web/deployment/create-project-template.md new file mode 100644 index 00000000..545ddbab --- /dev/null +++ b/docs/cookbook/web/deployment/create-project-template.md @@ -0,0 +1,40 @@ +# Creating your own project template + +* Preparation time: **3 minutes** + +### Create template + +Check out `syncano-node` repository: + +```sh +git clone git@github.com:Syncano/syncano-node.git +``` + +Then create your own template repository and copy empty template: + +```sh +# syncano-template-project- +cp -r syncano-node/packages/template-project-hello syncano-template-project-my-template +``` + +Now you can start editing template configuration file `syncano-template-project-my-template/package.json`: +- edit name of the package +- edit template files in `syncano-template-project-my-template/template` folder + +### Using template + +You can install your template locally in you project. To do that go to your project folder and run: + +```sh +# yarn add --dev +yarn add --dev ../syncano-template-project-my-template +``` + +If you template was submitted to [NPM](https://www.npm.com) you can install it as any other dependency: + +```sh +# yarn add --dev +yarn add --dev syncano-template-project-my-template +``` + +Now you will be able to find your template on the list of templates while executing `syncano-cli init` command.