Getting Started
Quick start
Looking to start your project quickly? Just unzip the Falcon-v3.4.0.zip
. We have precompiled and packaged everything in the public
directory for you. Start editing the public/pages/starter.html
with a text or code editor, save it, and open the file in your favourite browser to see the changes.
Setting up Build system
Unzip the Falcon-v3.4.0.zip
to any folder and open a command line or terminal at that location.
theme's dev tools require Node and Git . If you do not have them in your machine, please install their latest stable version from their corresponding website. As you have Node and Git installed and accessible from your terminal or command line, install Gulp CLI package
globally with the following command:
npm i gulp-cli -g
When youβre done, install the rest of the themeβs dependencies with:
npm i
Now run:
gulp
Running gulp will compile the SCSS, transpile the javascript, copy all required libraries form node_modules
to the corresponding public/assets/vendors
directory and will open a browser window to public/index.html
All of the following folders are monitored for changes, which will tell the browser to reload automatically after any changes are made:
public/assets/fonts/
public/assets/video/
public/assets/img/
public/vendors
src/pug/
src/scss/
src/js/
Now you can edit any pug
file from src/pug
, change SCSS variable with scss/_user-variables.scss
, or write your own SCSS code in scss/_user.scss
and add or update javaScript
from src/js
directory.
gulp
command will discard and regenerate all the files in following directories:public/**/*.html
public/assets/css/
public/assets/js/
public/vendors
Hit Ctrl+C
or just close the command line window to stop the server.
Happy editing!