Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jeroenoomsnl/generator-github-project-starter

Yeoman generator for 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/generator-github-project-starter

Last synced: about 10 hours ago
JSON representation

Yeoman generator for Github Project Starter, a boilerplate for Github frontend projects to save time on creating a build process and a demo pages for Github Pages.

Awesome Lists containing this project

README

        

# generator-github-project-starter [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Dependency Status][daviddm-image]][daviddm-url]
> A Yeoman generator for Github Project Starter

## Github Project Starter

The Github Project Starter is a boilerplate for Github projects to save time on creating a build process and a demo pages for Github Pages.

Watch this demo page for an example and more info:
[http://jeroenoomsnl.github.io/github-project-starter](http://jeroenoomsnl.github.io/github-project-starter)

## 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

## Installation

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:

```bash
gulp
```

## Getting To Know Yeoman

Yeoman has a heart of gold. He's a person with feelings and opinions, but he's very easy to work with. If you think he's too opinionated, he can be easily convinced. Feel free to [learn more about him](http://yeoman.io/).

## License

MIT © [Jeroen Ooms](http://jeroenooms.nl)

[npm-image]: https://badge.fury.io/js/generator-github-project-starter.svg
[npm-url]: https://npmjs.org/package/generator-github-project-starter
[travis-image]: https://travis-ci.org/jeroenoomsNL/generator-github-project-starter.svg?branch=master
[travis-url]: https://travis-ci.org/jeroenoomsNL/generator-github-project-starter
[daviddm-image]: https://david-dm.org/jeroenoomsNL/generator-github-project-starter.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/jeroenoomsNL/generator-github-project-starter