Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
This tool helps creating project scaffolding for JSX.
tag: v0.1.4

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
share
src
.gitignore
.npmignore
.travis.yml
HISTORY.md
LICENSE.md
README.md
gruntfile.js
package.json

README.md

jsx-init

Synopsis

This tool helps creating project scaffolding for JSX. JSX(http://jsx.github.io/) is a altJS programming language to achieve faster, safer code and make it easier.

This tool creates folders and copies following contents:

  • package.json for npm
  • README file
  • License file
  • Build setting file (Grunt)
  • .gitignore file

Motivation

This tool accelerates to jump in JSX programming. You can start programming, testing, building by using generated settings.

Installation

You can install jsx-init by using npm command:

$ npm install jsx-init

You can install to global too.

$ npm install -g jsx-init

Usage

Run the following command in your working folder:

$ mkdir awesomeproject
$ cde awesomeproject
$ jsx-init

There are no options. jsx-init asks you some questions like license, repository and so on.

Before running command, creating repository on github or bitbucket is prefered.

Templates

  • jsx-lib: Library for JSX code.
  • node-app: node.js cli application.

How to develop in the generated project

Add source files under the lib folder and src folder and add tests under the test folder. lib folder is for library files and src folder is for executable source files. Reusable modules should be in lib folder.

You can run test by using prove command:

# Run test (-v shows detail error information)
$ grunt test

Following default Grunt commands are available:

# Generate API reference
$ grunt doc

# Build application or library for JS project
$ grunt build

If there are some needed modules, use npm command:

sh $ npm install <package> --save

Publish to github

Before publishing, update synopsis and other descriptions to README.md.

After creating project repository on github, you can register files to repository like this:

$ git init
$ git add -a
$ git commit -m "first commit"
$ git remote add origin git@github.com:[your name]/[your project name].git
$ git push -u origin master

Publish to npm

Update package.json version string then type following command:

$ npm publish

Development jsx-init

Repository

Run Test

$ grunt test

Build

# Build application or library for JS project
$ grunt build

# Generate API reference
$ grunt doc

Author

License

MIT

Complete license is written in LICENSE.md.

Reference

Thanks

Something went wrong with that request. Please try again.