Public Repository

Last pushed: 2 days ago
Short Description
Short description is empty for this repo.
Full Description

Instructions

Styles & Javascript

Gulp is used to compile SCSS to css files. Gulp is a npm package and you need to install npm modules to use it.

Installation guide

You have to install those modules to be able to compile.

Gulp

You need to install Gulp globally to be able to use the gulp command

npm install -g gulp

Yarn

Yarn is a npm package which "replace" the npm package manager. It supports cache and faster installations.

npm install -g yarn
When Yarn is installed

In the terminal, go to the root of the project and run the command: yarn
This will install all necessary packages and when it is done, you can start compiling.

Compile

In the terminal at the root of the project you can write gulp to compile the SCSS files (And JavaScript is the configuration is set that way):

gulp

If you want the gulp command to run everytime you change a SCSS file, you run gulp watch:

gulp watch

Browser sync
If you want the browser to reload itself when a change is made you add a --proxy:

gulp watch --proxy=path

Example

gulp watch --proxy=mysite.dev

Use virtualhost to create a nice readable hostname to your project.

Production
If you want to minify all the CSS code into one file you use:

gulp --production

This can also be combined with the other command options.

Remember if you want to run production mode you have to go into inc/config.php and change devMode to false. Else then production compiled CSS/JS will not be used.

Troubleshooting
If it doesn't work as you expect, make sure you the gulpfile.js have the correct setup.
If you haven't added/removed a JS file, the default gulpfile.js should work without problem. But when you add a JS or SCSS file you have to add it into the gulpfile.js too. This is only when you run the --production mode. You manually add files to the compiling list in the gulpfile.js. This is because we don't want all javascript and scss files to be compiled into the production file.

On Production

When the site will be public, you want it to be in a production mode. Be sure to do these steps when this is about to happened.

  • Run gulp --production
  • inc/config.php
    • devMode = false
    • display_errors = Off
  • Make sure all the image paths are correct. Be sure that the image paths are not linked to your local installation. They should always be relative to the root which is often "/". Example src="/uploads/image.jpg" And not src="http://mysite.dev/uploads/image.jpg"
  • Make sure the MX Entry has correct setup in the Cpanel. If the system email is owned by the server the site is installed at, the MX Entry should be Local else if the email is located on an external server, the MX Entry should be Remote
Docker Pull Command
Owner
simondubois

Comments (0)