Skip to content

Commit 88ef7f8

Browse files
committed
Merge branch 'develop' of github.com:modularcode/modular-admin-html into develop
2 parents d472a66 + 8201eff commit 88ef7f8

46 files changed

Lines changed: 1706 additions & 1370 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 78 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,38 @@
44
> built in modular way. That makes it awesomely easy to scale, modify and maintain.
55
66
> This is the HTML version, which is great for enhancing and integrating it into other platforms and environments.
7-
> AngularJS, React and Meteor versions are coming soon.
7+
> AngularJS, Angular2, React and Meteor versions are coming soon.
88
99
<a href="http://modularcode.github.io/modular-admin-html/" target="_blank">
1010
![demo](http://modularcode.github.io/modular-admin-html/assets/demo.png)
1111
</a>
1212

13-
Demo: http://modularcode.github.io/modular-admin-html/
13+
<p align="center">
14+
<strong>
15+
<a href="http://modularcode.github.io/modular-admin-html/" target="_blank">View Demo</a> | <a href="https://github.com/modularcode/modular-admin-html/archive/master.zip" target="_blank">Download ZIP</a>
16+
</strong>
17+
</p>
18+
19+
### Table of contents
20+
21+
* [Browser support](#browser-support)
22+
* [Getting started](#getting-started)
23+
* [Folder structure](#folder-structure)
24+
* [File types](#file-types)
25+
* [Build tasks](#build-tasks)
26+
* [Get in touch](#get-in-touch)
27+
28+
-------
29+
30+
## Browser support
31+
32+
* Last 2 Versions FF, Chrome, IE 10+, Safari Mac
33+
* IE 10+
34+
* Android 4.4+, Chrome for Android 44+
35+
* iOS Safari 7+
36+
37+
Some of the components use new Flexbox Layout module which is available in modern browsers. Bootstrap4 is used as main fraimwork.
38+
Please make sure if that's suitable for you [Flexbox browser support](http://caniuse.com/#feat=flexbox).
1439

1540
## Getting Started
1641

@@ -22,7 +47,7 @@ npm install -g bower
2247

2348
Clone repository to local `modular-admin` folder
2449
```
25-
git clone git@github.com:modularcode/modular-admin-html.git modular-admin -b master --single-branch
50+
git clone git@github.com:modularcode/modular-admin-html.git modular-admin
2651
```
2752

2853
Change to new folder
@@ -61,7 +86,17 @@ Open the project [http://localhost:4000](http://localhost:4000).
6186
└── package.json # npm configuration file
6287
```
6388

64-
```src/``` folder
89+
#### ```src/``` folder
90+
91+
In this folder are our application source files located.
92+
The folder structure represents app component structure.
93+
94+
Each non-underscored folder represents a single component module. Modules can be nested inside each other.
95+
96+
There are also special folders which start with underscore.
97+
For example ```_common/``` folder contains common components that are used by other components at the same lavel.
98+
99+
This file structuring makes our app file organization very semantic and scalable. Also It's very easy to work on separate components even if we're developing large-scale application.
65100

66101
```
67102
├── _assets/ # application assets
@@ -71,8 +106,10 @@ Open the project [http://localhost:4000](http://localhost:4000).
71106
├── _themes/ # different theming versions
72107
├── app/ # app module (dashboard view)
73108
│ ├── _common/ # app common components
74-
│ | ├── header/ # header files
109+
│ | ├── editor/ # whyiwyg editor files
75110
│ | ├── footer/ # footer files
111+
│ | ├── header/ # header files
112+
│ | ├── modals/ # common modal dialogs (confirm, image library, etc)
76113
│ | └── sidebar/ # sidebar files
77114
│ ├── {different modules}
78115
│ ├── app-layout.hbs # app view layout
@@ -89,15 +126,49 @@ Open the project [http://localhost:4000](http://localhost:4000).
89126
90127
```
91128

92-
```build/``` folder
129+
#### ```build/``` folder
93130

94-
@ToDo
131+
In this folder are located files related to our application building. That can be stype preprocessors and template engine compilation, script files concatenation and minification and other related tasks.
132+
133+
```
134+
├── paths/ # application file paths
135+
| ├── app.js # application file paths
136+
| └── vendor.js # 3-rd party plugins paths
137+
├── tasks/ # tasks folder
138+
| └── {different tasks} # each file represents a single build task
139+
├── utils/ # some utils
140+
├── config.js # build configs
141+
└── gulpfile.js # main build file for gulp build system
142+
143+
```
144+
145+
#### ```public/``` folder
146+
147+
Compiled state of our app with processed styles, templates, scripts and assets.
148+
149+
**Warning! Never work inside this folder, because your changes would be overwritten on every build**
95150

96151

97152
## File Types
98153

154+
Our app consists of different file types.
155+
99156
#### Styles (*.scss)
100157

158+
We use [SASS](http://sass-lang.com/) as CSS preprocessor language.
159+
Main variables are defined in ```src/_variables.scss``` folder.
160+
For making life easier we broke down styles into components, and on build we're just merging all ```.scss``` files together and processing it to ```pubilc/css/app.css``` file. Style files are merged in following order
161+
162+
```
163+
{variables.scss}
164+
{bootstrap variables}
165+
{bootstrap mixins}
166+
{rest style files}
167+
```
168+
The rest style files are merged in alphabetical order depending on their deepth level.
169+
170+
There are also different theme variations located in ```src/_themes/``` folder, where you can overwrite main variables and get different themes. There are few predefined themes built in. You can add new theme by adding new file in ```src/_themes/``` folder. The file name should end with ```-theme.scss```.
171+
101172
#### Scripts (*.js)
102173

103174
#### Layouts (*-layout.hbs)

build/gulpfile.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ gulp.task('watch', function() {
7070

7171
// Builds and deploys to github pages
7272
gulp.task('deploy', ['build'], function() {
73-
return gulp.src('../public/**/*')
73+
return gulp.src('../dist/**/*')
7474
.pipe(plugins.ghPages({
7575
cacheDir: '../.deploy'
7676
}));

dist/buttons.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,7 @@
190190
<span class="l l3"></span>
191191
<span class="l l4"></span>
192192
<span class="l l5"></span>
193-
</div>
194-
ModularAdmin
193+
</div> ModularAdmin
195194
</div>
196195
</div>
197196
<nav class="menu">

dist/cards.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,7 @@
190190
<span class="l l3"></span>
191191
<span class="l l4"></span>
192192
<span class="l l5"></span>
193-
</div>
194-
ModularAdmin
193+
</div> ModularAdmin
195194
</div>
196195
</div>
197196
<nav class="menu">

dist/charts-flot.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,7 @@
190190
<span class="l l3"></span>
191191
<span class="l l4"></span>
192192
<span class="l l5"></span>
193-
</div>
194-
ModularAdmin
193+
</div> ModularAdmin
195194
</div>
196195
</div>
197196
<nav class="menu">

dist/charts-morris.html

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -190,8 +190,7 @@
190190
<span class="l l3"></span>
191191
<span class="l l4"></span>
192192
<span class="l l5"></span>
193-
</div>
194-
ModularAdmin
193+
</div> ModularAdmin
195194
</div>
196195
</div>
197196
<nav class="menu">

0 commit comments

Comments
 (0)