Skip to content

Commit 04f8093

Browse files
committed
Update README.md
1 parent 77dfeac commit 04f8093

1 file changed

Lines changed: 52 additions & 6 deletions

File tree

README.md

Lines changed: 52 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
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)
@@ -22,7 +22,7 @@ npm install -g bower
2222

2323
Clone repository to local `modular-admin` folder
2424
```
25-
git clone git@github.com:modularcode/modular-admin-html.git modular-admin -b master --single-branch
25+
git clone git@github.com:modularcode/modular-admin-html.git modular-admin
2626
```
2727

2828
Change to new folder
@@ -61,7 +61,17 @@ Open the project [http://localhost:4000](http://localhost:4000).
6161
└── package.json # npm configuration file
6262
```
6363

64-
```src/``` folder
64+
#### ```src/``` folder
65+
66+
In this folder are our application source files located.
67+
The folder structure represents app component structure.
68+
69+
Each non-underscored folder represents a single component module. Modules can be nested inside each other.
70+
71+
There are also special folders which start with underscore.
72+
For example ```_common/``` folder contains common components that are used by other components at the same lavel.
73+
74+
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.
6575

6676
```
6777
├── _assets/ # application assets
@@ -71,8 +81,10 @@ Open the project [http://localhost:4000](http://localhost:4000).
7181
├── _themes/ # different theming versions
7282
├── app/ # app module (dashboard view)
7383
│ ├── _common/ # app common components
74-
│ | ├── header/ # header files
84+
│ | ├── editor/ # whyiwyg editor files
7585
│ | ├── footer/ # footer files
86+
│ | ├── header/ # header files
87+
│ | ├── modals/ # common modal dialogs (confirm, image library, etc)
7688
│ | └── sidebar/ # sidebar files
7789
│ ├── {different modules}
7890
│ ├── app-layout.hbs # app view layout
@@ -89,15 +101,49 @@ Open the project [http://localhost:4000](http://localhost:4000).
89101
90102
```
91103

92-
```build/``` folder
104+
#### ```build/``` folder
105+
106+
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.
93107

94-
@ToDo
108+
```
109+
├── paths/ # application file paths
110+
| ├── app.js # application file paths
111+
| └── vendor.js # 3-rd party plugins paths
112+
├── tasks/ # tasks folder
113+
| └── {different tasks} # each file represents a single build task
114+
├── utils/ # some utils
115+
├── config.js # build configs
116+
└── gulpfile.js # main build file for gulp build system
117+
118+
```
119+
120+
#### ```public/``` folder
121+
122+
Compiled state of our app with processed styles, templates, scripts and assets.
123+
124+
**Warning! Never work inside this folder, because your changes would be overwritten on every build**
95125

96126

97127
## File Types
98128

129+
Our app consists of different file types.
130+
99131
#### Styles (*.scss)
100132

133+
We use [SASS](http://sass-lang.com/) as CSS preprocessor language.
134+
Main variables are defined in ```src/_variables.scss``` folder.
135+
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
136+
137+
```
138+
{variables.scss}
139+
{bootstrap variables}
140+
{bootstrap mixins}
141+
{rest style files}
142+
```
143+
The rest style files are merged in alphabetical order depending on their deepth level.
144+
145+
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```.
146+
101147
#### Scripts (*.js)
102148

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

0 commit comments

Comments
 (0)