A solid footing for web applications.

This repository contains the source code for the main footwork.js website, as well as the different documentation releases. If you want to contribute to the main documentation, or the website in general then this is the repository you are looking for.

Related links:

• Main Website

• Documentation/API

• Get Started

  • Install via Yeoman (recommended)

  • Skeleton Application (based on the Yeoman generator)

Running this website

The main footwork website is a Laravel 5 PHP application, so you will need a system that has php 5.4 or later installed.

1. Clone the repo from GitHub:

git clone https://github.com/footworkjs/footworkjs.com.git
cd footworkjs.com

2. Acquire PHP dependencies:

Make sure you have composer installed, then run the following:

# Warning, this command will take a while most likely
composer install

3. Acquire npm and bower dependencies:

Make sure you have node.js and bower installed in your environment, then run the following:

npm install && bower install

4. Rename .env.example file

Laravel uses a local .env file to determine what environment the application is running in. The repository has an example one saved as .env.example. You will need to rename this file to .env.

4a) (optional) Setup the releases folder

The download widget on the front page won't work unless the releases folder is setup (which houses the different releases referenced on/from that widget). Follow these instructions if you wish to set that up.

For versions 0.8.1 to 1.1.0:

# Change to the 'releases' folder under the base path
cd releases

# Clone whatever versions you would like to have available
git clone -b 0.8.1 --single-branch --depth 1 https://github.com/footworkjs/footwork.git 0.8.1
git clone -b 1.0.0 --single-branch --depth 1 https://github.com/footworkjs/footwork.git 1.0.0
git clone -b 1.1.0 --single-branch --depth 1 https://github.com/footworkjs/footwork.git 1.1.0

And thats it...the application will use this folder to lookup and provide the available releases inside of that widget.

5. Set permissions on the storage directory

# This allows laravel to create its cache/etc
chmod -R a+rw storage

6. Compile the LESS into CSS, bundle + minify the Javascript, zip up the demo application files

There are tasks outlined further below which will launch a watch process that will automatically rebuild the css and javascript for you. This (the default) task will build both of them, plus the demo zip files. This is basically the 'prep-everything' for first use task:

# Run the default gulp task to build the javascript, css, and zip up the demo files
gulp

7. Run the site (if needed)

This final step is necessary if you do not have your own HTTP server setup locally.

cd public
php -S localhost:8000

# access the site locally on your browser at http://localhost:8000

Other Gulp Tasks

There are several other included gulp tasks, they are as follows:

# Build the javascript
gulp build-js

# Watch the CSS and JS and rebuild as appropriate
gulp watch

# Watch the CSS and rebuild as appropriate
gulp watch-css

# Watch the JS and rebuild as appropriate
gulp watch-js

# Build the demo application zip assets
gulp makeDemoBuilds

License

MIT license - http://www.opensource.org/licenses/mit-license.php