Skip to content

Commit

Permalink
Version appendage, more README updates.
Browse files Browse the repository at this point in the history
  • Loading branch information
Marty Wallace committed Mar 11, 2015
1 parent c0b6d9f commit f887082
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 7 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,18 @@ Tempest makes use of various tools to streamline the development process:
* [NodeJS & Node Package Manager](http://nodejs.org/), for managing Grunt tasks.
* [Bower](http://bower.io/), for managing front-end JavaScript dependencies.
* [Grunt](http://gruntjs.com/), for running Grunt tasks.
* [Ruby](http://rubyinstaller.org/), required by SASS.
* [SASS](http://sass-lang.com/install), for compiling SASS.
* [TypeScript](http://www.typescriptlang.org/#Download), for compiling TypeScript.

## Getting Started.

1. Download and extract the files to your server - `public` should be set as the server root.
* Set up a virtual host; [these instructions](http://sawmac.com/xampp/virtualhosts/) may help beginners.
* Using PHP's [inbuilt server](http://php.net/manual/en/features.commandline.webserver.php) is much easier than the above.
* Set up a virtual host; [these instructions](http://sawmac.com/xampp/virtualhosts/) may help beginners, or;
* Use PHP's [inbuilt server](http://php.net/manual/en/features.commandline.webserver.php). Simply navigate to the application root, then:

$ php -S localhost:80 -t public

2. `cd` to your application directory and run the following commands:

$ npm install
Expand All @@ -25,7 +31,14 @@ Tempest makes use of various tools to streamline the development process:

## Development Guide.

#### JavaScript & TypeScript.
### Grunt.

[Grunt](http://gruntjs.com/) is used to automate the compilation of various files into the public directory (e.g. `/sass` into `/public/css`). There are two grunt tasks available:

1. `grunt dev` (default) - compiles files without minification and runs a watch task for use during development.
2. `grunt prod` - compiles and minifies files for production use.

### JavaScript & TypeScript.

* Put your JavaScript or TypeScript files into `js/app/`. They will be compiled down into `public/js/app.js`.
* For JavaScript dependencies;
Expand All @@ -34,19 +47,19 @@ Tempest makes use of various tools to streamline the development process:
* These will be cocatenated down into `public/js/vendor.js`.
* Tempest comes with some JavaScript of its own. It is compiled down into `public/js/tempest.js`.

#### SASS.
### SASS.

* Put your SASS into `sass/`. Your SASS will be compiled down into `public/css/`.
* Files beginning with `_` will not be compiled, following standard SASS rules.
* Some useful boilerplate SASS is located in `sass/vendor/`.

#### HTML & Twig.
### HTML & Twig.

* Tempest uses [Twig](http://twig.sensiolabs.org/) for templating.
* Put your Twig & HTML files in `html/`.
* These files are not manipulated or compiled in any way; Tempest will look in `html/` for Twig templates.

#### Configuration.
### Configuration.

* Application configuration is stored in `config.php`. More instructions on configuration are provided at the top of the file.

Expand All @@ -55,8 +68,14 @@ Tempest makes use of various tools to streamline the development process:
* [1.0.0](https://github.com/MartyWallace/Tempest/releases/tag/1.0.0)
* Modern project structure (using `public` for public files).
* Using Twig for templating.
* Added Grunt for task automation.
* Added SASS & TypeScript compilation.
* Added Bower for JavaScript dependency management.
* Added Composer for PHP dependency management.
* Application services.
* Cascading app configuration based on server name.
* General cleanup.

* [0.0.1](https://github.com/MartyWallace/Tempest/releases/tag/0.0.1)
* This release is explained in the [wiki section](https://github.com/MartyWallace/Tempest/wiki).
* Custom logicless templating.
Expand Down
2 changes: 1 addition & 1 deletion html/tempest/_layout.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h6>NAMED</h6>

<div id="foot">
<div class="grid">
<p><a target="_blank" href="https://github.com/MartyWallace/Tempest">Tempest version 1.0.0</a> &middot; Developed by Marty Wallace.</p>
<p><a target="_blank" href="https://github.com/MartyWallace/Tempest">Tempest version {{ tempest.getVersion() }}</a> &middot; Developed by Marty Wallace.</p>
</div>
</div>
</body>
Expand Down
8 changes: 8 additions & 0 deletions server/tempest/Tempest/Tempest.php
Original file line number Diff line number Diff line change
Expand Up @@ -311,4 +311,12 @@ public function getRouter(){ return $this->router; }
*/
public function getServices(){ return $this->services; }


/**
* Returns the current version of Tempest.
*
* @return string
*/
public function getVersion(){ return '1.0.0'; }

}

0 comments on commit f887082

Please sign in to comment.