Skip to content

Commit 5a4063c

Browse files
committed
Merge branch 'master' of github.com:modularcode/modular-admin-html
2 parents 7f68bff + 103a093 commit 5a4063c

1 file changed

Lines changed: 26 additions & 12 deletions

File tree

README.md

Lines changed: 26 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ AngularJS, Angular2, React and Meteor versions are coming soon.
5050

5151
Some of the components use new Flexbox Layout module which is available in modern browsers. Bootstrap4 is used as main fraimwork.
5252
Please make sure if that's suitable for you [Flexbox browser support](http://caniuse.com/#feat=flexbox).
53-
53+
<br>
5454
## Getting Started
5555

5656
For assembling the application, you need to have [NodeJs](https://nodejs.org/en/) with npm. You also need to have Bower installed globally.
@@ -88,6 +88,7 @@ Open the project [http://localhost:4000](http://localhost:4000).
8888

8989
> The project is built by Gulp. You can read more info in [Build Tasks](#build-tasks) section
9090
91+
<br>
9192
## Folder Structure
9293

9394
```
@@ -120,7 +121,7 @@ This file structuring makes our app file organization very semantic and scalable
120121
├── _themes/ # different theming versions
121122
├── app/ # app module (dashboard view)
122123
│ ├── _common/ # app common components
123-
│ | ├── editor/ # whyiwyg editor files
124+
│ | ├── editor/ # wysiwyg editor files
124125
│ | ├── footer/ # footer files
125126
│ | ├── header/ # header files
126127
│ | ├── modals/ # common modal dialogs (confirm, image library, etc)
@@ -161,8 +162,8 @@ In this folder are located files related to our application building. That can b
161162
Compiled state of our app with processed styles, templates, scripts and assets.
162163

163164
**Warning! Never work inside this folder, because your changes would be overwritten on every build**
164-
pu
165165

166+
<br>
166167
## File Types
167168

168169
Our app consists of different file types.
@@ -214,7 +215,7 @@ list:
214215
- Three
215216
---
216217
```
217-
and **_context.js** files ([example](https://github.com/modularcode/modular-admin-html/blob/master/src/_context.js)).
218+
and **_context.js** files.
218219
```
219220
module.exports = {
220221
foo: 'bar',
@@ -227,32 +228,45 @@ module.exports = {
227228
}
228229
```
229230

230-
The final result of page context is compination of both ways. Moreover, different depth level _context.js files are extending each other and then are extended with YAML headers data. In our case we have ```src/_context.js``` file, where main website properties are defined and YAML headers in ```*-page.hbs``` files.
231+
The final result of page context is compination of both ways. Moreover, different depth level _context.js files are extending each other and then are extended with YAML headers data. For simplicity we use only **YAML** headers.
231232

232233
#### Layouts (*-layout.hbs)
233234

234235
If different pages have lot of common components like sidebar, header, footer, It's a good idea to define a layout for those common pages and define in page files only the content which is unique.
235236

236237
Layout is a page content wrapper. If the page has layout in output we'll get page's content inserted into layout. Layouts should have ```{{{body}}}``` handlebars tag, which is entry point for page content. ([example](https://github.com/modularcode/modular-admin-html/blob/master/src/app/app-layout.hbs))
237238

238-
To define a page layout you need to specify page file context's ```layout``` variable. It can be done both by YAML header or _context.js file. ([example](https://github.com/modularcode/modular-admin-html/blob/master/src/app/forms/forms-page.hbs))
239+
To define a page layout you need to specify page file context's ```layout``` variable. It can be done both by YAML header or _context.js file. ([example](https://github.com/modularcode/modular-admin-html/blob/master/src/app/forms/forms-page.hbs)).
240+
241+
Layouts can also have contexts and parent layouts.
239242

240-
If you need more advanced layouting you can use [handlebar-layouts](https://www.npmjs.com/package/handlebars-layouts) helper approach, which is also available out of the box.
243+
```
244+
{_main-layout.hbs} # main layout with doctype, head, scripts declaration
245+
{app/app-layout.hbs} # dashboard layout with sidebar, header and footer
246+
{app/forms/forms-page.hbs} # any dashboard page
247+
```
248+
249+
250+
If you need more advanced layouting with multiple content blocks at the same time you can use [handlebar-layouts](https://www.npmjs.com/package/handlebars-layouts) helper approach, which is also available out of the box.
241251

242252
#### Vendor files
243253

244254
Except application files there are also third party plugin files (e.g. Bootstrap). They are managed by using [Bower](http://bower.io/). Usually vendor libraries consist from scripts, styles and assets (images, fonts). The build system will concatenate and copy all script and style files correspondingally to ```dist/js/vendor.js```and ```dist/css/vendor.css``` also will copy all assets to ```dist/assets/``` folder.
245255

256+
<br>
246257
## Build Tasks
247258

248-
259+
<br>
249260
## Get in touch
250261

251-
Usually we're discussing stuff [ModularCode Facebook Group](https://www.facebook.com/groups/710770032358423/).
262+
Usually we're discussing stuff in [ModularCode Facebook Group](https://www.facebook.com/groups/710770032358423/).
252263
Feel free to reach us for any questions, sugestions, remarks and potential feature requests.
253264

254-
Gevorg Harutyunyan | [LinkedIn](https://www.linkedin.com/profile/view?id=AAMAAA7ne4gBF-IVNsoiBaeOeDTd5YGSTVN2eBs) | [Facebook](https://www.facebook.com/madextreme) | [Twitter](https://twitter.com/mad4extreme) | [gevharut@gmail.com](mailto:gevharut@gmail.com)
265+
* Gevorg Harutyunyan | [LinkedIn](https://www.linkedin.com/profile/view?id=AAMAAA7ne4gBF-IVNsoiBaeOeDTd5YGSTVN2eBs) | [Facebook](https://www.facebook.com/madextreme) | [Twitter](https://twitter.com/mad4extreme) | [gevharut@gmail.com](mailto:gevharut@gmail.com)
266+
* Aram Manukyan | [LinkedIn](https://www.linkedin.com/profile/view?id=AAkAABCehqwBm7aTR7IohpOidW1sVIHMo33U46o)
267+
* David Tigranyan | [LinkedIn](https://www.linkedin.com/profile/view?id=AAkAAAk1QJIB86I-V65l3qtgpTvfrMozBNc4p_8)
255268

256-
Aram Manukyan [LinkedIn](https://www.linkedin.com/profile/view?id=AAkAABCehqwBm7aTR7IohpOidW1sVIHMo33U46o)
269+
## Hire Us?
257270

258-
David Tigranyan [LinkedIn](https://www.linkedin.com/profile/view?id=AAkAAAk1QJIB86I-V65l3qtgpTvfrMozBNc4p_8)
271+
Do you have a great project? Need theme customization or intagration with back-end? Want to create something awesome?
272+
We may be available for hire. Just drop a message to [gevharut@gmail.com](mailto:gevharut@gmail.com) and let's talk.

0 commit comments

Comments
 (0)