@js-primer/local-server/README.md

Local Server for js-primer.

# @js-primer/local-server

Local Server for [JavaScript Primer](https://github.com/asciidwango/js-primer "js-primer").

### Requirements

- Node.js 10+
    - It contains `npm`  5.3.0>=
    - It contains `npx` command 

## Usage

`npx`コマンドを使い直接ダウンロードと実行ができます。

    Usage
      $ npx @js-primer/local-server [<directory>]

    Options:
      --port  TCP port at which the files will be served

サーバを起動する（ベースディレクトリは現在ディレクトリ）

    npx @js-primer/local-server

指定したディレクトリをベースにサーバを起動する

    npx @js-primer/local-server ./docs

指定したポート番号でサーバを起動する

    npx @js-primer/local-server --port 8000

起動したローカルサーバは、コマンドラインで<kbd>Ctrl+C</kbd>のショートカットを押下することで終了できます。

### Usage for old Node.js

Node.js 8.2未満の場合は[npm](https://www.npmjs.com/)でインストールすることで利用できます。

    npm install local-server --global
    $ js-primer-local-server

## Changelog

See [Releases page](https://github.com/js-primer/local-server/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/js-primer/local-server/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## License

MIT © azu