ここでは、Volt のすべての機能をドキュメント化するつもりです。最終的に機能を決定するのはプログラムのコード自体ですが、可能な限りドキュメントを最新の状態に保つようにします。
新規の Volt アプリケーションには、はじめからいくつかのフォルダ/ファイルが含まれています。
| 名前 | 詳細 |
|---|---|
| app | アプリケーションのコンポーネントをサブフォルダに含みます |
| config | アプリケーションの設定と、起動時に実行されるコード (initializer) を含みます |
| config.ru | Rack 互換サーバーがアプリケーションを起動するのに使用する特別なファイルです |
| spec | すべての Rspec のテスト (specs) を含みます |
| Gemfile | プロジェクトが依存するすべての Gem を指定します |
| Gemfile.lock | Bundler によって生成され、Gem のバージョンを追跡するためのファイルです |
| README.md | プロジェクトのための Markdown ファイルです |
ほとんどのアプリケーションのコードは app 内のコンポーネントのフォルダに存在します。アプリケーションは、再利用性やテストのために、独立したコンポーネントに分割することができます。デフォルトでは、Volt は「main」という1つのコンポーネントを生成します。Volt を学ぶ際には、すべてを「main」に入れることが可能です。
コンポーネントはいくつかの標準的な構成のフォルダを含みます。
| 名前 | 詳細 |
|---|---|
| assets | CSS/JS/画像/フォントなどの静的なアセット |
| config | コンポーネント特有の設定と依存関係の管理 |
| controllers | UI の表示や、そのモデルへの接続を構成するクラス |
| lib | コンポーネントに必要な追加の Ruby コード |
| models | データ、パーミッション、バリデーション、そしてビジネスロジックを管理するクラス |
| views | ブラウザ上でレンダリングされてアプリケーションを表示するための HTML ファイル |
これから、コンポーネントのより詳細な内容の前に、コンポーネントの各パートについて記載します。