Markup builder on gulp
English description | Описание на русском
TARS is a builder for modern frontend of any complexity, which is based on Gulp.js. It facilitates and accelerates process of web-development. TARS will be suitable for teams and individual developers. It solves the most routine cases associated with web-development and brings you more pleasure from work.
TARS is a framework for gulp, including a set of gulp-tasks. It allows for easy expansion (creating new tasks) and customization (modification of existing tasks), provides comfortable architecture for tasks and watchers storage in the project.
To bypass dependencies installation for every TARS project, TARS-CLI was created. As such, TARS is not a npm-package by itself. This decision was made so that everyone could comfortably customize the builder for themselves. TARS-CLI is just a simple builder interface, which includes all dependencies for TARS.
It is strongly recommended to use TARS-CLI for development.
You can install TARS-CLI via NPM. More info in project's repository.
Attention! All docs from branch "master" are written for the last version of TARS. If you have another version of TARS, please, open appropriate release and take docs from there. Besides, you have all docs, which are 100% compatible with your project in the root folder of your project!
Listed below are just a little part of the features. In fact builder has much more.
It is important! All examples in documentation use the default settings.
Attention, TARS-CLI is the preferred way to work with TARS. It is faster and more comfortable to work with TARS-CLI. In case of using TARS with TARS-CLI all installation steps are not necessary!
You need to install Node.js
with version equal to 4.x.x and higher. If you use Node.js version 5.x.x, please, make sure, that you use npm version 3.x.x and higher. Otherwise update npm by using command:
npm i -g npm
For Windows you have to do some more steps:
npm install npm@latest
.If you get a Permission denied or Error: EACCES error, you should run the previous command again in sudo (as Administrator for Windows).
Next you need to install gulp globally. (You may need rights of superuser or administrator).
npm install -g gulp
Download TARS and unzip it in the working directory. Then install dependencies. Command is run from a folder with TARS files (usually it is a tars-master).
npm install
If not all of the dependencies have been installed, the last operation must be repeated.
After installing of all dependencies you need to open tars-config (detailed description of the options are here) and set up the project for yourself. In that config file, you can select the templater, css-preprocessor, using the notifications, folder names for different static and etc. After setting up the project, execute the following command:
gulp init
Attention, TARS-CLI is the preferred way to work with TARS. It is faster and more comfortable to work with TARS-CLI. Init command is available in TARS-CLI too.
This command will create the basic file structure, download tasks for selected templater and css-preprocessor. Everything is ready, get to work! :)
Attention, TARS-CLI is the preferred way to work with TARS. It is faster and more comfortable to work with TARS-CLI. All commands are available and described in TARS-CLI, so use only TARS-CLI for working with your project. TARS used Gulp to start tasks, when CLI was not created.
gulp init
— initializes project with the specified settings in the tars-config. Creates a file structure.
gulp re-init
— This command is deprecated! reinitialize the project with specified settings in the tars-config. It is advised to use this command if you initialize the project with incorrect options. Attention, files from pages and static folder will be deleted.
gulp
or gulp build
— build project. Non-minimized files are used by default. Build type depends on command parameters.
Available parameters:
--min
– minimized files are connected to html.--release
– minimized files are connected to html whose names have hash. This mode is useful if you are trying to directly deploy ready markup to the server.gulp dev
— initialize of builder in development mode. Dev-version of the project is created without any minifications. It also launches watchers for project files.
Available parameters:
--lr
– initialize livereload (live page reloads with changes in project files), if it is included in the configuration of the project.--tunnel
– initialize project with markup sharing to the external web.The link will be shown in the console. There also will be a link to the control panel for devices to which markup is shared.
gulp build-dev
— generation of dev-version of the project without watchers.
These parameters are available in any mode of assembly:
--ie8
– to include in the build styles for ie8.--ie9
– to include in the build styles for ie9.--ie
– to include in the build styles for ie8 and ie9.It is important! All examples in documentation use the default settings.
All recent changes are available here: changelog.
If you have a question you can write in gitter or mail [email protected]
Bugs and feature-request here: issues.