The front end of this project is set up with node, bower and gulp.
To be able to run the front end on your pc, you will need to follow these steps.
Pre-requisites include Node.js, Ruby, Python and Visual Studio. This seems like overkill but some of the node packages need to compile languages specific to your environment.
- Install node.js. Add to PATH if prompted.
- Install Ruby. Add to PATH if prompted.
- Install Python. Add to PATH if prompted.
- If you don't not have visual studio installed, download the free community version from here.
Now that you have all of the above:
- Open up a command prompt and type 'npm install -g bower'.
- In the same command prompt, type 'npm install -g gulp'.
Now open up a command prompt in the root of the front end (This should be the folder that has the 'gulpfile.babel.js' file).
- In the command propmt run 'npm install'. This will install the npm modules dependencies for the project.
- Then run 'bower install'. This will install the bower dependencies.
If all of the above ran succesfully, you can now start the project usig the commands below. If you encountered errors, don't worry. Googling usually helps. If you're stuck, contact your nearest front end developer for help.
Once the project is setup on your computer, the following commands are available from the command line. To run these commands, open up a command prompt at the root for the front end (This should be the folder that has the 'gulpfile.babel.js' file).
In your command prompt, type 'gulp serve' and hit enter. This will open your project in you browser with browsersync and live compiling enabled. This means that any changes made to the source files in the 'app' folder will be automatically pushed to the browser.
In your command prompt, type 'gulp serve:dist' and hit enter. This is similar to the command above, except it will serve the files from 'dist' folder.
In your command prompt, type 'gulp build' and hit enter. This will compile all of your files in the 'app' folder, then move the compiled files into the 'dist' folder. The files in the dist file are production ready and will be used by the project.