Update Readme with custom-templates listing #383

reznord · 2017-09-25T17:03:02Z

Updates the README reflecting changes to custom templates which is the highlight for 2.0.

Any inputs are more than welcome.

Please do not merge this PR until we are planning for a release.

prateekbh · 2017-09-25T17:34:42Z

README.md


-### Using Yarn
+- [material] - material-ui template using preact-material-components


"material template...." material-ui might be confusing with react's material-ui

lukeed

Have to step out, but started going thru this.

lukeed · 2017-09-26T17:55:06Z

README.md

-### Templates
+Note:
+
+1. You can run dev server using`HTTPS` then you can use the following `HTTPS=true preact watch`


Missing space before HTTPS

lukeed · 2017-09-26T17:55:20Z

README.md

+  --src         Entry file (index.js)                            [string]   [default: "src"]
+  --port, -p    Port to start a server on                        [string]   [default: "8080"]
+  --host,       Hostname to start a server on                    [string]   [default: "0.0.0.0"]
+  --https       Use HTTPS?                                       [boolean]  [default: false]


Don't need ?

lukeed · 2017-09-26T17:57:42Z

README.md


-### Commands
+Prerequisites: [Node.js](https://nodejs.org/en/) required version (> 6.x)


How about > **Important:** Node v6.x is the minimum requirement.

silverlight513 · 2017-09-26T18:08:06Z

Made a few tweaks and put it into gist:
https://gist.github.com/silverlight513/35a3c85df18eef73963bc61be146a9b7

I've bullet pointed my suggested updates into a review

silverlight513

Updates

Moved the templates subsection to under the Official Templates section
Changed title from template to Custom templates
Updated content of Custom templates

lukeed · 2017-09-26T18:11:04Z

@silverlight513 Thanks! 🙏

I think this is a good example to point out that we need to clarify that the "template" in Official Templates is a different thing than the --template flag.

Nesting them under each other will surely, imo, add to the confusion.

silverlight513 · 2017-09-26T18:17:07Z

Ah, from the looks of it they appeared to be the same thing. My bad.

@lukeed, would you mind explaining the difference between the --template flag and the Official Templates so that I can update my gist to try and make it clearer that they're separate.

reznord · 2017-09-26T18:58:25Z

@lukeed @silverlight513 thanks for the reviews and your time 🙏

Official Templates

Till now (the current version) we were just using the code in the examples folder for boot-strapping new projects using preact cli.

But in the next version (v2.0) we moved to custom-templates which will pull the the project from the github/bitbucket. There is a specific structure which these custom-templates need to follow, i.e. they need to place the entire code in a template/ folder.

The contents in the template/ folder from the repo will be used as a template for the project.

Template flag

The template here refers to a custom HTML file which the user can specify for either preact build, preact watch commands.

By default in preact-cli we don't expose the HTML file as CRA does. So, we support a --template flag through which we can pass a custom HTML file where you can add external stylesheets/scripts.

You can use them in the following way:

Build command: preact build --template path/to/template.html
Serve command: preact serve --template path/to/template.html

lukeed · 2017-09-26T19:02:03Z

@silverlight513 No problem, I'm sure you're not/won't be the only one.

The --template flag is for passing a path to a custom index.html replacement. This is useful for adding <meta> tags to your head, etc. TBH, this may be removed soon in favor of always writing the built-in template.html into your working directory.

The "Official Templates" (or any template) is a new 2.0 feature which allows you to scaffold a new project from an external repository. Here, "template" is synonymous with "boilerplate." The motivation here is to allow community-driven, reusable templates so that users don't feel restricted to what's included in Preact CLI directly.

lukeed · 2017-10-09T19:54:48Z

We'll definitely update this as we go along. Better to have something reflective of the current repo sooner rather than later.

* master: (166 commits) Use `publicPath` for SW & Manifest paths (#323) Purge `examples` dir (#393) Update Readme (#383) Add `preact list` command (#384) linters are dumb inject / replace strings in extracted contents adding flag to disable service worker Convert `css-loader` options to an Object (#349) remove `offline-plugin` (unused) remove `mkdirp` (unused) remove `less` dependencies fix linter move `htmlPlugin` to `render-html-plugin.js` install `css|postcss|style-loader` & regen `yarn.lock` remove `chunk.modules` deprecation notice rewrite server’s `webpack.config` without blocks rewrite client’s `webpack.config` without blocks install `webpack-merge` rewrite base `webpack.config` w/o blocks light refactor ... # Conflicts: # src/lib/webpack/webpack-base-config.js

reznord added 2 commits September 25, 2017 22:25

Update Readme with custom-templates listing

9860f90

Add preact create example in the tip

49c051f

prateekbh reviewed Sep 25, 2017

View reviewed changes

reznord added 2 commits September 26, 2017 01:44

Add preact list to readme

0c6df1b

typo fix

68f7e9b

reznord mentioned this pull request Sep 25, 2017

feature: preact list #384

Merged

reznord added this to the 2.0 milestone Sep 26, 2017

reznord added 2 commits September 26, 2017 18:06

Merge branch 'master' into update-readme

df01fc8

Fix a markdown issue

bd07085

lukeed reviewed Sep 26, 2017

View reviewed changes

silverlight513 reviewed Sep 26, 2017

View reviewed changes

Typo fixes

544a0fc

Change prerequsite message

bd5cd2f

lukeed approved these changes Oct 9, 2017

View reviewed changes

lukeed merged commit d7f20bd into master Oct 9, 2017

lukeed deleted the update-readme branch October 9, 2017 19:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Readme with custom-templates listing #383

Update Readme with custom-templates listing #383

reznord commented Sep 25, 2017

prateekbh Sep 25, 2017

lukeed left a comment

lukeed Sep 26, 2017

lukeed Sep 26, 2017

lukeed Sep 26, 2017

silverlight513 commented Sep 26, 2017

silverlight513 left a comment

lukeed commented Sep 26, 2017

silverlight513 commented Sep 26, 2017 •

edited

Loading

reznord commented Sep 26, 2017

lukeed commented Sep 26, 2017

lukeed commented Oct 9, 2017


		### Using Yarn
		- [material] - material-ui template using preact-material-components


		### Commands
		Prerequisites: [Node.js](https://nodejs.org/en/) required version (> 6.x)

Update Readme with custom-templates listing #383

Update Readme with custom-templates listing #383

Conversation

reznord commented Sep 25, 2017

prateekbh Sep 25, 2017

Choose a reason for hiding this comment

lukeed left a comment

Choose a reason for hiding this comment

lukeed Sep 26, 2017

Choose a reason for hiding this comment

lukeed Sep 26, 2017

Choose a reason for hiding this comment

lukeed Sep 26, 2017

Choose a reason for hiding this comment

silverlight513 commented Sep 26, 2017

silverlight513 left a comment

Choose a reason for hiding this comment

lukeed commented Sep 26, 2017

silverlight513 commented Sep 26, 2017 • edited Loading

reznord commented Sep 26, 2017

lukeed commented Sep 26, 2017

lukeed commented Oct 9, 2017

silverlight513 commented Sep 26, 2017 •

edited

Loading