Add boostrap command. #17

brendandahl · 2015-09-30T22:56:06Z

Starting point for the boostrap command which creates the skeleton template app in any folder. The process for starting from template would now be

git clone [email protected]:brendandahl/testogh.git
cd testogh
oghliner bootstrap
gulp build
gulp deploy

Or we could just dooghliner deploy app instead of the last two steps.

More things we could do:

auto fill out package.json with data from git config (we should use node module gulp-template)
prompt user for app name or maybe parse this from git url
run bootstrap from oghliner to build dist directory

mykmelez · 2015-10-01T04:55:38Z

After oghliner bootstrap, you also need to npm install gulp in order to do gulp build, even though you have global gulp, because gulp evaluates gulpfile.js, which requires a local instance of gulp.

(If there was a package.json, this could be npm install.)

mykmelez · 2015-10-01T04:56:50Z

(Then you need to npm install gulp-connect and npm install oghliner.)

mykmelez · 2015-10-02T05:19:18Z

One other thought: if we copy the files to template/app/ rather than moving them there, then we can differentiate between the content of the template and the content of Oghliner's own website. It would also reduce the differences between the template's gulpfile.js and Oghliner's own version of that file, since Oghliner's own version could build from app/ instead of template/app/.

mykmelez · 2015-10-02T05:37:54Z

Note: I made a few updates to the content of app/index.html and updated the file globs in gulpfile.js to offline all the files in app/ (it was missing some of them because I hadn't updated the globs after I used the GitHub Pages Generator to design a nicer layout for the site).

brendandahl · 2015-10-06T21:50:48Z

(Then you need to npm install gulp-connect and npm install oghliner.)

Missed my package file. The local dependencies should be installed by gulp-install.

So now I think we're at:

npm install -g gulp oghliner
git clone [email protected]:brendandahl/testogh.git
cd testogh
oghliner bootstrap
gulp offline
gulp deploy

mykmelez · 2015-10-07T00:16:21Z

gulpfile.js

@@ -23,7 +23,7 @@ var oghliner = require('./index.js');
 gulp.task('default', ['build', 'offline']);

 gulp.task('build', function(callback) {
-  return gulp.src('app/**').pipe(gulp.dest('dist'));
+  return gulp.src('templates/app/**').pipe(gulp.dest('dist'));


Now that you're no longer removing the app/ subdirectory, this should continue to build app/ rather than templates/app/.

mykmelez · 2015-10-07T00:31:24Z

The output with gulp-conflict is a bit scary, since it puts the word conflict in every line:

10-06 17:28 > oghliner bootstrap
[17:29:05] [conflict] Creating app
[17:29:05] [conflict] Creating gulpfile.js
[17:29:05] [conflict] Creating package.json
[17:29:05] [conflict] Creating app/images
[17:29:05] [conflict] Creating app/index.html
[17:29:05] [conflict] Creating app/scripts
[17:29:05] [conflict] Creating app/styles
[17:29:05] [conflict] Creating app/images/bg_hr.png
[17:29:05] [conflict] Creating app/images/blacktocat.png
[17:29:05] [conflict] Creating app/images/icon_download.png
[17:29:05] [conflict] Creating app/images/sprite_download.png
[17:29:05] [conflict] Creating app/scripts/offline-manager.js
[17:29:05] [conflict] Creating app/styles/github-light.css
[17:29:05] [conflict] Creating app/styles/stylesheet.css

But it seems like a good idea to use it anyway.

mykmelez · 2015-10-07T00:37:24Z

The other output I noticed are these warnings:

npm WARN package.json [email protected] No description
npm WARN package.json [email protected] No repository field.
npm WARN package.json [email protected] No README data
npm WARN package.json [email protected] No license field.

I'm not sure how to pick a license for the user, although perhaps NPM would be satisfied if we added the field and gave it an empty string value. That reminds me that we should probably put the template files into the public domain (except for the ones already copyrighted by GitHub, of course). I'll ping licensing to confirm that.

As for description and repository, we should be able to pick sensible values for those. And creating a blank README.md file probably satisfies the README warning.

brendandahl · 2015-10-07T00:39:24Z

The output with gulp-conflict is a bit scary,

My thought too, I'll look into removing it.

As for package.json, we could prompt the user during bootstrap for values.

mykmelez · 2015-10-07T00:39:35Z

npm install -g gulp oghliner
git clone [email protected]:brendandahl/testogh.git
cd testogh
oghliner bootstrap
gulp offline
gulp deploy

The other thing to do is commit the newly created files to the master branch, something like:

git add app/ gulpfile.js package.json && git commit -m"bootstrap app using Oghliner"

Which reminds me of two more things:

We should include a template .gitignore to ignore the node_modules directory.
We should update the README to document this new way to bootstrap an app (and stop recommending that users clone or merge the repo).

mykmelez · 2015-10-07T00:40:17Z

As for package.json, we could prompt the user during bootstrap for values.

Ah, good idea!

brendandahl · 2015-10-07T21:16:19Z

add .gitignore
public domain files

mykmelez · 2015-10-07T21:47:51Z

lib/bootstrap.js

+  var config = {
+    name: "oghliner-template-app",
+    repository: "https://oghliner-template-app.git",
+    description: "A template app boostrapped with oghliner.",


Nit: boostrapped -> bootstrapped.

mykmelez · 2015-10-08T23:09:21Z

Looks good! I heard back from licensing and filed #38 to release the template files to the public domain, so we can follow up on that there.

Add boostrap command.

Add boostrap command.

3adc447

brendandahl force-pushed the bootstrap branch from 9fc4581 to 3adc447 Compare October 6, 2015 21:48

mykmelez reviewed Oct 7, 2015
View reviewed changes

Remove unintended change.

b97a868

brendandahl added 2 commits October 7, 2015 13:54

Add prompts to fill out package.json.

9c5557b

Update read.

6375a60

mykmelez reviewed Oct 7, 2015
View reviewed changes

brendandahl added 4 commits October 8, 2015 14:59

Fix nit.

db1f7b2

Change default license.

0972b64

Swap the template files back.

d1f7137

Add .gitignore file.

ac3e437

mykmelez added a commit that referenced this pull request Oct 8, 2015

Merge pull request #17 from brendandahl/bootstrap

21f1f57

Add boostrap command.

mykmelez merged commit 21f1f57 into mozilla:master Oct 8, 2015

marco-c mentioned this pull request Oct 15, 2015

flesh out Oghliner template app #7

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add boostrap command. #17

Add boostrap command. #17

brendandahl commented Sep 30, 2015

mykmelez commented Oct 1, 2015

mykmelez commented Oct 1, 2015

mykmelez commented Oct 2, 2015

mykmelez commented Oct 2, 2015

brendandahl commented Oct 6, 2015

mykmelez Oct 7, 2015

mykmelez commented Oct 7, 2015

mykmelez commented Oct 7, 2015

brendandahl commented Oct 7, 2015

mykmelez commented Oct 7, 2015

mykmelez commented Oct 7, 2015

brendandahl commented Oct 7, 2015

mykmelez Oct 7, 2015

mykmelez commented Oct 8, 2015

Add boostrap command. #17

Add boostrap command. #17

Conversation

brendandahl commented Sep 30, 2015

mykmelez commented Oct 1, 2015

mykmelez commented Oct 1, 2015

mykmelez commented Oct 2, 2015

mykmelez commented Oct 2, 2015

brendandahl commented Oct 6, 2015

mykmelez Oct 7, 2015

Choose a reason for hiding this comment

mykmelez commented Oct 7, 2015

mykmelez commented Oct 7, 2015

brendandahl commented Oct 7, 2015

mykmelez commented Oct 7, 2015

mykmelez commented Oct 7, 2015

brendandahl commented Oct 7, 2015

mykmelez Oct 7, 2015

Choose a reason for hiding this comment

mykmelez commented Oct 8, 2015