2bbb / js-primer

JavaScriptの入門書 :book:

[WIP] JavaScriptの入門書

この書籍はES2015以降をベースとしたJavaScript入門書となる予定です。

プログラミングをやったことがあるが、今のJavaScriptがよくわからないという人が、 今のJavaScriptアプリケーションを読み書きできるようになるもの。

ハッシュタグは #jsprimer です。

⚠️ Status ⚠️

この書籍は開発中の内容となっています。

どのような構成になるか興味がある人は次のIssueを見てみるとよいです。

• [meta] 全体的な設計/ユースケース一覧 #6

どのような経緯で動いているかはミーティングノートを参照してください。

• Meeting Notes

リポジトリの更新を追いたい方はリポジトリをWatchしてください。

また、下記フォームからメールアドレスを登録しておくと更新情報を受け取れます。

• 更新通知を受け取るメールアドレスを登録するフォーム

Installation

npm install

Node.js 6.0.0以上が必要です。

Usage

Build

GitBookのbuildをします

npm run build

Watch

GitBookのbuildかつWatchをします。 プレビューをする場合は、ローカルサーバを利用してください。

次のコマンドを実行後、http://localhost:4000/へアクセスすることでプレビューを見られます。

npm run start
# open http://localhost:4000/

Test

このプロジェクトでは文章やコードに対してテストを実行しています。 文章中のインラインコードのテスト、特定のファイル名にもとづくテスト、コメントを使ったDocTestなどが含まれます。

以下のコマンドを実行すると全てのテストが実行されます。

npm i -d && npm test

詳しくは CONTRIBUTING.md を見てください。

Contributing

小さなtypoでもIssueやPull Requestを歓迎しています。

コントリビュートの方法や確認方法についてはCONTRIBUTING.mdを見てください。

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

License

• コードはMITライセンス
• 文章はCC BY-NC 4.0