You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[ModularAdmin](http://modularcode.github.io/modular-admin-html/) is an open source dashboard theme built in a modular way. That makes it extremely easy to scale, modify and maintain.
16
16
17
17
18
+
## Getting Started
18
19
19
-
## Download
20
+
### 1. Download
20
21
21
-
You can download this project in 2 different ways: <ahref="https://github.com/modularcode/modular-admin-html/releases/download/v1.2.0/modular-admin-html-1.2.0.zip"target="_blank">download zip</a> or ```git clone https://github.com/modularcode/modular-admin-html.git ```.
22
+
You can download this project in 2 different ways: <ahref="https://github.com/modularcode/modular-admin-html/releases"target="_blank">download zip</a> or ```git clone https://github.com/modularcode/modular-admin-html.git ```.
The downloaded zip file will contain ```dist/``` folder which is compiled version of the project (with all scripts are merged together, processed styles and templates). You can use it as final result, but for development you should use aplication sources locaed in ```src/``` folder and rebuild the project. See [development](#development).
26
-
27
-
**Warning!** all changes made in ```dist/``` folder would be overwriten on application build.
28
26
29
27
#### Git clone
30
28
31
29
Clone repository to the local `modular-admin-html` folder
The cloned repository desn't contain prebuilt version of the project and you need to build it, See [development](#development).
37
-
38
-
## Other versions
39
-
40
-
This is the HTML version, which is great for enhancing and integrating it into other platforms and environments.
41
-
AngularJS, Angular2, React and Meteor versions are coming soon.
42
-
43
-
### Table of contents
44
-
45
-
*[Browser support](#browser-support)
46
-
*[Development](#development)
47
-
*[Docker](#docker)
48
-
*[Folder structure](#folder-structure)
49
-
*[File types](#file-types)
50
-
*[Build tasks](#build-tasks)
51
-
*[Get in touch](#get-in-touch)
52
-
53
-
-------
54
-
55
-
## Browser support
56
-
57
-
* Last 2 Versions FF, Chrome, IE 10+, Safari Mac
58
-
* IE 10+
59
-
* Android 4.4+, Chrome for Android 44+
60
-
* iOS Safari 7+
61
-
62
-
Some of the components use the new Flexbox Layout module which is available in most modern browsers. Bootstrap4 is used as main framework. Please make sure that it's suitable for you: [Flexbox browser support](http://caniuse.com/#feat=flexbox).
63
-
64
-
<br>
65
-
66
32
67
-
## Development
68
-
69
-
For building the application, you need to have [NodeJs](https://nodejs.org/en/) with npm. You also need to have [Bower](http://bower.io/) installed globally.
33
+
```
34
+
### 2. Build the project
70
35
71
-
After [downloading](#download) run the following commands from the project folder:
36
+
The cloned/downloaded repository desn't contain prebuilt version of the project and you need to build it. You need to have [NodeJs](https://nodejs.org/en/) with npm. You also need to have [Bower](http://bower.io/) installed globally.
72
37
73
-
Install bower globally
74
-
```
75
-
npm install -g bower
76
-
```
77
38
78
39
Install npm dependencies
79
40
```
80
41
npm install
81
42
```
82
43
83
-
Install front-end bower dependencies
44
+
Install bower dependencies
84
45
```
85
46
bower install
86
47
```
@@ -92,7 +53,14 @@ npm start
92
53
93
54
Open the project [http://localhost:4000](http://localhost:4000).
94
55
95
-
> The project is built by Gulp. You can read more info in [Build Tasks](#build-tasks) section
56
+
> The project is built by Gulp.
57
+
58
+
59
+
**Warning!** all changes made in ```dist/``` folder would be overwriten on application build.
60
+
61
+
62
+
-------
63
+
96
64
97
65
## Running in Docker
98
66
@@ -109,6 +77,8 @@ Launch the container
109
77
docker-compose up
110
78
```
111
79
80
+
-------
81
+
112
82
<br>
113
83
114
84
## Folder Structure
@@ -279,10 +249,6 @@ In addition to application files, there are also third party plugin files (e.g.
279
249
280
250
<br>
281
251
282
-
## Build Tasks
283
-
284
-
<br>
285
-
286
252
## Get in touch
287
253
288
254
You can get in touch with us in gitter chat [](https://gitter.im/modularcode/modular-admin?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) or in the [ModularCode Facebook Group](https://www.facebook.com/groups/710770032358423/).
0 commit comments