Local Environment

BEFORE STARTING

Local webserver is required! Smarty scripts are not loaded as a local file!

If you already installed GULP, you can quick start an webserver:
gulp webserver --root html_frontend
- or - for the admin:
gulp webserver --root html_admin
Anyway, a local webserver is recommended!

First of all we would like to thank you for choosing Smarty!
After more than 3 years of continuous support and taking notes from all feedbacks, we hope that Smarty will serve you as you expect.

Smarty Updates

We always try to keep up and release new updates. We never stopped more than 3 years and for sure we are not going to stop now when finally, Smarty Reborn (version 3+) is rewritten from scratch and ready for serious job. If this is not the first time you use Smarty, you already noticed that we never changed the html structure.

This time we had to rewrite everything, including creating 20 plugins from scratch to get the best performance possible and also taking care not to leave bugs by writing them. This part was easy because Smarty is not just a selling template, is not a simple product! Smarty is also our main framework used in our own projects, including large SAAS applications. We do really care and we promise that new more amazing features will come in the next updates.

Thank you again for choosing Smarty, for choosing to be part of Smarty Community.

Smarty Support

We did the best we could to write a good documentation for each plugin and component. But we know very well what means to get stuck because we also get stuck sometimes when we are playing with something new. We do everything that is in our power to offer all the support and assistance you need. Our support also covers all design-related issues, not only code issues.

If you have issues, please feel free to contact us by using our contact form. We do the best we can to get back to you within 24 hours. Sometimes might take a little longer but we usualy answer as soon as we can. Thank you!

Author: Stepofweb / Dorin Grigoras
Product page: {wrapbootstrap}
Email support: sow.smarty@gmail.com

STARTING WITH GULP

What is Gulp?

Gulp is a toolkit for automating painful or time-consuming tasks in your development workflow, so you can stop messing around and build something.

If the official explanation don't tell you much, Gulp is used to compile .scss files, to concatenate multiple js/css files (creating a single final file from many), to minify files and a lot more other things by adding almost any type of plugin (limit is the sky - there are over than 3000 plugins and growing).

As an overview, getting started is simple: install npm -> install gulp -> build.

1. Install NODE

You need to install Node first.

2. Install GULP

Node was the most important because now we have npm command to install gulp:

npm install --global gulp

3. Install Smarty Modules

At this point, your PC is ready for development. You can check the installation by typing: npm --version and gulp --version
Now we install the required modules used by Smarty to compile the final css/js files. A directory called npm_modules will be created.
In the same directory with package.json file, type in your console:

npm install

4. Compile Files

Now you can see all Smarty functions in GULP by typing:

gulp :help

This final step will create the final css/js files in dist directory, ready for production (to use them in your project):

gulp

Wasn't that much, isn't it? Each time you change something in js/scss files, you need to repeat the last step.
BUT! You can also use the watch function and will autobuild when you make changes and save.

gulp watch

New Project

Useful to start a new fresh project. Will create a folder containing the files you need to start.
A builtin webserver is also available! After creating the new project folder, your can start a webserver.

gulp create --new my_project
gulp webserver --root my_project (watch + webserver + browser autoreload)

gulp watch --dest my_project

* an watcher is active for "my_project". When changes are detected to src/js/* & src/scss/*, files are rebuilt.
all available tasks can be seen by typing gulp :help.

Deploy

A deploy using rsync is available. You can deploy files to production server and/or staging (indentical environment with production server but for testing purpose only (sometimes is a subdomain)). First, you need to edit gulp.config.settings.js to enter server details (ip, username, paths)

gulp deploy:production 
gulp deploy:staging

Smarty Structure

	├── dist/
	│   └── result of the built process goes here
	│
	├── _gulp/
	│   └── gulp micro-framework
	│
	├── node_modules/
	│   └── build process required modules
	│
	├── src/
	│   ├── js/
	│   │   ├── sow.config.js
	│   │   ├── sow.core/
	│   │   └── vendors/
	│   ├── scss/
	│   │   └── sass core files
	│   ├── html/
	│   │   └── Coming Soon - replace in HTML
	│   └── _starter/
	│       └── files used by "gulp :create"
	│
	└── html_frontend/
	│   └── all Smarty html files (also used as official demo)
	│
	└── html_admin/
	│   └── all Smarty html files (also used as official demo)
	│
	└── gulpfile.babel.js
	│
	├── gulp.config.__plugins.js
	│   └── enable/disable SOW plugins
	│
	├── gulp.config.__vendors.js
	│   └── enable/disable/add Vendor plugins
	│
	├── gulp.config.settings
	│   └── GULP settings - compile destination, etc
	│
	└── README_FIRST.html

VIDEOS

Here are some videos - better with visuals!