Markup builder on gulp
JavaScript CSS
Latest commit eb4b4ec Jan 11, 2017 @krontill krontill committed with artem-malko Update README_RU.md (#308)

README.md

English description | Описание на русском

Tars

Downloads Mac/Linux Build Status Windows Build status Gitter

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!

Basic features

Listed below are just a little part of the features. In fact builder has much more.

  • Jade, Pug or Handlebars as html templater. You can also use a regular html. Read more in docs.
  • Webpack (with Hot Module Replacing) or simple JavaScript code concatenation into one bundle.
  • Using json (js-object actually, which can be described in json) to transfer data in templates (optional, but it is a very cool thing that will let you get rid of copypaste). Read more in docs.
  • TARS-CLI and auto update of your project.
  • You can use ES6 (and some experimental features from ES7) right now. More info.
  • SCSS (SASS), LESS or Stylus as a preprocessor for css. Also it includes a small set of mixins. Sourcemaps are included. You can use .scss and .sass extension then scss is selected as preprocessor. You can use .scss and .sass files together. Read more in docs. PostCSS with autoprefixer is supported by default and it is really easy to use additional plugins for PostCSS.
  • No external libraries or plugins (except html5shiv). Yes, this is a feature because you can choose which library to use. Sourcemaps for JavaScript are included.
  • Chokidar module is used to watch files
  • Optional markup sharing from your local computer to the world. And of course it has livereload in browser (and not just locally) + GUI control panel for devices, to which markup is shared.
  • You can easily add new tasks and watchers. There are several examples of how to create and use a new task or watcher inside the TARS. Thereby, it is really easy to add any task from your builder to TARS or integrate TARS into your project.
  • Smart work with images. First of all with vector (svg). There will be no more hell with markup for screens with high pixel density. TARS supports two workflows of working with SVG: SVG-sprites and SVG-symbols.
  • Several modes of assembly (common, with minified files, with hash in the title of css and js files for deployment).
  • Creating archive with a complete build.

Documentation

It is important! All examples in documentation use the default settings.

Installation

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:

  • navigate to C:\Program Files (x86)\nodejs or C:\Program Files\nodejs via cmd.exe or any available terminal. The path depends on how Node.js was installed;
  • run command 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! :)

Basic commands

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-initThis 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.

Documentation

It is important! All examples in documentation use the default settings.

Last changes

All recent changes are available here: changelog.

If you have a question you can write in gitter or mail tars.builder@gmail.com

Bugs and feature-request here: issues.