Skip to content

Commit

Permalink
[DOC] update README for felayout
Browse files Browse the repository at this point in the history
  • Loading branch information
dmh committed May 5, 2017
1 parent c8607c0 commit d7f263a
Showing 1 changed file with 25 additions and 22 deletions.
47 changes: 25 additions & 22 deletions felayout_t3kit/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,6 @@
# felayout_t3kit
[![Release](https://img.shields.io/github/release/t3kit/felayout_bluemountain.svg?style=flat-square)](https://github.com/t3kit/felayout_bluemountain/releases)

[![Build Status](https://travis-ci.org/t3kit/felayout_bluemountain.svg?branch=master)](https://travis-ci.org/t3kit/felayout_bluemountain)

Front-End layout for [theme_t3kit_bluemountain](https://github.com/t3kit/theme_t3kit_bluemountain) project

### [CHANGELOG](https://github.com/t3kit/felayout_bluemountain/blob/master/CHANGELOG.md)
### [Contributing to t3kit](https://github.com/t3kit/t3kit/blob/master/CONTRIBUTING.md)
## Front-End layout for **theme_t3kit**

### Required dependencies:

Expand All @@ -15,25 +9,34 @@ Front-End layout for [theme_t3kit_bluemountain](https://github.com/t3kit/theme_t
- [NPM](https://github.com/npm/npm) >=3.10.8
- [Grunt-cli](http://gruntjs.com/) >=1.2.0 `npm install -g grunt-cli`

### Installation:
***

First, clone repo:
```bash
git clone [email protected]:t3kit/felayout_bluemountain.git
```

Next, install NPM dependencies:
### Install NPM dependencies:

```bash
cd felayout
npm install
```

### Getting Started:
***

## `felayout_t3kit` includes CSS and JS source files for theme_t3kit project.

1. `felayout_t3kit` works closely with t3kit docker, so to start developing using felayout we need to [install and run t3kit using docker configuration](https://github.com/t3kit/t3kit#development)


2. Next step we need disable default styling (CSS) and JS scripts in t3kit to be able to insert it (CSS/JS) dynamically from felayout_t3kit. For this, we need to change `FElayout mode` constant from `less` to `development`.
* TYPO3 BE -> tab `Themes` -> `Expert` -> `FElayout mode`

3. Next step is to run local server (_proxied from t3kit TYPO3 installation_) `localhost:9001` wich includes all CSS/LESS/JS files (`theme_t3kit/felayout_t3kit/dev`) with livereloading. For this, we need to use command `grunt`.

4. Last step. After all changes (CSS/LESS/JS) which you did in `felayout` you will need to compile FE files into `theme_t3kit/Resources/Public/css` or `theme_t3kit/Resources/Public/less` folder using comands: `grunt compileCss` or `grunt compileLess`. Also, keep in mind that these compilated files should be committed by separate commit with a message `update css/less` without any prefixes. [Commit messages without prefixes shouldn't go to changelog files](https://github.com/t3kit/t3kit/blob/master/CONTRIBUTING.md#labels). **Do not commit compilated files together with source files from `theme_t3kit/felayout_t3kit/dev`**



### Grunt commands:

- Run `grunt` to start static server with livereload `localhost:9004`
- Run `grunt +less` to start static server [_same as `grunt`_] plus it generates all Front-End service files plus **LESS** styling for CMS needs, and copy it to `less` folder. _[with livereload]_
- Run `grunt +css` to start static server [_same as `grunt`_] plus it generates all Front-End service files plus **CSS** styling for CMS needs, and copy it to `css` folder. _[with livereload]_
- Run `grunt check` to check HTML/CSS/JS files according project code conventions
- Run `grunt pushSite` to build your static site and push it to separate branch `site`
- Run `grunt pushCss` to compile all Front-End service files plus **CSS** styling for CMS needs, copy it to separate branch `css` and push to remote git server.
- Run `grunt pushLess` to compile all Front-End service files plus **LESS** styling for CMS needs, copy it to separate branch `less` and push to remote git server.
- Run `grunt` to start local server (_proxied from t3kit TYPO3 installation_) with livereload `localhost:9001`
- Run `grunt check` to check CSS (.stylelintrc) and JS (JS standard) files according code conventions.
- Run `grunt compileCss` or `grunt cc` to compile all Front-End service files plus **CSS** styling for **t3kit** needs and copy it to `theme_t3kit/Resources/Public/css` folder.
- Run `grunt compileLess` or `grunt cl` to compile all Front-End service files plus **LESS** styling for **t3kit** needs, copy it to it to `theme_t3kit/Resources/Public/less` folder.

0 comments on commit d7f263a

Please sign in to comment.