https://github.com/joeybaker/js-project-template

A project template for javascript
https://github.com/joeybaker/js-project-template

Last synced: 3 days ago
JSON representation

A project template for javascript

• Host: GitHub
• URL: https://github.com/joeybaker/js-project-template
• Owner: joeybaker
• License: other
• Created: 2014-10-03T17:04:00.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-01-17T00:03:50.000Z (about 10 years ago)
• Last Synced: 2025-01-09T15:19:42.890Z (19 days ago)
• Language: Shell
• Size: 234 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Title

[![NPM](https://nodei.co/npm/{{name}}.png)](https://nodei.co/npm/{{name}}/) [![Build Status](https://travis-ci.org/{{username}}/{{name}}.png?branch=master)](https://travis-ci.org/{{username}}/{{name}}) ![Depencency status](https://david-dm.org/{{username}}/{{name}}.png)

{{DESCRIPTION}}

**Table of Contents**  *generated with [DocToc](http://doctoc.herokuapp.com/)*

- [Install](#install)

- [Usage](#usage)

- [Methods](#methods)

- [Events](#events)

  - [myEvent `( myString)`](#myevent-string-mystring)

- [Tests](#tests)

- [Developing](#developing)

  - [Requirements](#requirements)

- [TODO](#todo)

- [Changelog](#changelog)

  - [1.0.0](#100)

## Install

`npm install {{name}}`

## Usage

```js

var {{camelName}} = require('{{name}}')

```

## Methods

## Events

### myEvent `( myString)`

Emitted when x happens. Passes `myString` which is a y.

## Tests

Tests are [prova](https://github.com/azer/prova), based on [tape](https://github.com/substack/tape). They can be run with `npm test`.

Tests can be run in a loop with `npm run tdd`

## Developing

To publish, run `npm run release -- [{patch,minor,major}]`

_NOTE: you might need to `sudo ln -s /usr/local/bin/node /usr/bin/node` to ensure node is in your path for the git hooks to work_

### Requirements

* **npm > 2.0.0** So that passing args to a npm script will work. `npm i -g npm`

* **git > 1.8.3** So that `git push --follow-tags` will work. `brew install git`

## TODO

* [x] integrate https://github.com/inikulin/dmn

* [x] integrate https://github.com/thlorenz/doctoc

## Changelog

### 1.0.0

Initial Release