https://github.com/dariusk/grunt-init-textgen

A grunt-init template for text generating pages with twitter/link sharing.
https://github.com/dariusk/grunt-init-textgen

Last synced: about 2 months ago
JSON representation

A grunt-init template for text generating pages with twitter/link sharing.

• Host: GitHub
• URL: https://github.com/dariusk/grunt-init-textgen
• Owner: dariusk
• Created: 2013-08-01T15:04:13.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-08-13T17:16:37.000Z (about 9 years ago)
• Last Synced: 2024-06-20T10:27:57.155Z (3 months ago)
• Language: JavaScript
• Size: 163 KB
• Stars: 10
• Watchers: 4
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# grunt-init-textgen

> Create a Wordnik-based text generator/sharer with [grunt-init][].

[grunt-init]: http://gruntjs.com/project-scaffolding

## Installation

If you haven't already done so, install [grunt-init][].

Once grunt-init is installed, place this template in your `~/.grunt-init/` directory. It's recommended that you use git to clone this template into that directory, as follows:

```

git clone [email protected]:dariusk/grunt-init-textgen.git ~/.grunt-init/textgen

```

_(Windows users, see [the documentation][grunt-init] for the correct destination directory path)_

## Wordnik API key

Sign up for a free account at https://www.wordnik.com/signup and then request a developer key at https://developer.wordnik.com/

Edit ```permissions.js``` and add the API key in.

## Usage

At the command-line, cd into an empty directory, run this command and follow the prompts.

```

grunt-init textgen

npm install

grunt watch

[edit some files, like js/app.js]

[open index.html in your browser, served through a local web server]

```

_Note that this template will generate files in the current directory, so be sure to change to a new directory first if you don't want to overwrite existing files._