https://github.com/jeroenoomsNL/github-project-starter

A boilerplate for Github frontend projects to save time on creating a build process and a demo pages for Github Pages.
https://github.com/jeroenoomsNL/github-project-starter

Last synced: about 2 months ago
JSON representation

A boilerplate for Github frontend projects to save time on creating a build process and a demo pages for Github Pages.

• Host: GitHub
• URL: https://github.com/jeroenoomsNL/github-project-starter
• Owner: jeroenoomsNL
• Archived: true
• Created: 2015-12-19T22:07:21.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-08T18:58:29.000Z (about 9 years ago)
• Last Synced: 2024-08-07T23:46:56.265Z (6 months ago)
• Language: HTML
• Homepage: http://jeroenoomsnl.github.io/github-project-starter/
• Size: 42 KB
• Stars: 7
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Github Project Starter

A boilerplate for Github projects to save time on creating a build process and a demo pages for Github Pages.

## Features

-	Build process with [Gulp](http://gulpjs.com) for html, css, javascript and images

-	Deploy task for [Github Pages](https://pages.github.com)

-	Pretty styled and customizable demo page with [initialize.css](http://jeroenoomsnl.github.io/initialize-css/)

-	The [Yeoman](http://yeoman.io) generator makes it easy to install

-	And lots of best practices

## Easy installation with Yeoman!

First, install [Yeoman](http://yeoman.io) and generator-github-project-starter using [npm](https://www.npmjs.com/) (we assume you have pre-installed [node.js](https://nodejs.org/)).

```bash

npm install -g yo

npm install -g generator-github-project-starter

```

Then generate your new project:

```bash

yo github-project-starter

```

## Build your project

Build with Gulp

`gulp`

Watch locally (starts browser with browserSync)

`gulp watch`

Deploy to Github Pages

`gulp deploy`

or

`gulp deploy --message 'My first commit'`