Skip to content

Commit

Permalink
docs(articles): add several basic articles
Browse files Browse the repository at this point in the history
  • Loading branch information
lugovsky committed May 13, 2016
1 parent 490c5b0 commit de12e97
Show file tree
Hide file tree
Showing 14 changed files with 176 additions and 1,340 deletions.
5 changes: 2 additions & 3 deletions docs/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,8 @@
"paginator": {
"perPage": 3,
"groupSort": {
"First Group": 100,
"Second Group": 200,
"Third Group": 50
"Quick Start": 1000,
"Customization": 900
}
}
}
43 changes: 43 additions & 0 deletions docs/contents/articles/001-getting-started/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Getting Started
author: vl
sort: 999
group: Quick Start
template: article.jade
---

## What is BlurAdmin?

Blur admin is Angular front-end Admin Dashboard template. That means all data you can see on graphs, charts tables is hardcoded in Javascript. You can use any backend you want with it without limitations.

## How can it help me?

We believe that that at the moment a lot of business applications have some kind of admin interface inside of them. Sometimes it's not that obvious, but a lot of web applications have dashboard with panels, charts analytics.

BlurAdmin aims to bootstrap development of your product and provide ecosystem for building a prototype or even production-ready application.

Despite frameworks like Bootstrap provide a number of components, usually it's not enough of them to build real-world app. This template comes with lots of popular UI components with unified color scheme.

As well you can use BlurAdmin for learning purposes.

## List of features

* Responsive layout
* High resolution
* Bootstrap CSS Framework
* Sass
* Gulp build
* AngularJS
* Jquery
* Jquery ui
* Charts (amChart, Chartist, Chart.js, Morris)
* Maps (Google, Leaflet, amMap)
* etc

## I want to start developing with BlurAdmin

Welcome abroad!

You can start with [Installation Guidelines](/blur-admin/articles/002-installation-guidelines/). We describe there how can you download and run template on you local machine.

Good luck and have fun!
46 changes: 46 additions & 0 deletions docs/contents/articles/002-installation-guidelines/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Installation Guidelines
author: vl
sort: 500
group: Quick Start
template: article.jade
---

## Prerequisites

Despite BlurAdmin can be run without any development experience, it would be much easier if you already know something about it. In general following instruction do allow to run local copy by complete newbie, but it doesn't answer questions that can arise in the process of installation.

## Install tools

If you don't havee any of these tools installed already, you will need to:
* Download and install [git](https://git-scm.com/)
* Download and install nodejs [https://nodejs.org](https://nodejs.org)

**Note**: It seems like there are some problems with some libraries used in this template and old node versions. That's why we suggest you to have one of the latest.

## Clone repository and install dependencies

You will need to clone source code of BlurAdmin GitHub repository. To do this open console and execute following lines:
```bash
git clone https://github.com/akveo/blur-admin.git
```
After repository is cloned, go inside of repository directory and install dependencies there:
```bash
cd blur-admin
npm install
```
This will setup a working copy of BlurAdmin on your local machine

## Running local copy

To run local copy in development mode, execute:
```bash
gulp serve
```
This script should automatically open template in your default browser.

To run local copy in production mode, execute:
```bash
gulp serve:dist
```
For addition information about build, please check out [this angular generator](https://github.com/Swiip/generator-gulp-angular)
50 changes: 50 additions & 0 deletions docs/contents/articles/011-changing-color-scheme/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Changing Color Scheme
author: vl
sort: 900
group: Customization
template: article.jade
---

If you want to change template color scheme, you just need to do 4 simple steps:

1) Change color scheme in javascript (`src/app/theme/theme.constants.js`):
```javascript
// main color scheme
var colorScheme = {
primary: '#209e91',
info: '#2dacd1',
success: '#90b900',
warning: '#dfb81c',
danger: '#e85656',
};

// background color palette
var bgColorPalette = {
blueStone: '#005562',
surfieGreen: '#0e8174',
silverTree: '#6eba8c',
gossip: '#b9f2a1',
white: '#ffffff',
};
```
- css colors and javascript colors in colorScheme object should be the same
- background color palette is used for the pie traffic chart and calendar on the dashboard page

2) Change colors in css (`src/sass/theme/conf/_colorScheme.scss`):

```scss
$primary: #209e91 !default;
$info: #2dacd1 !default;
$success: #90b900 !default;
$warning: #dfb81c !default;
$danger: #e85656 !default;
```

3) Replace background images: `src/app/assets/img/blur-bg.jpg` and `src/app/assets/img/blur-bg-blurred.jpg`

4) build source files and run application: `gulp` and `gulp serve`

Below is an example of template with another color scheme:

![](new-color-scheme.jpg)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
33 changes: 33 additions & 0 deletions docs/contents/articles/012-project-structure/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
title: Project Structure
author: vl
sort: 800
group: Customization
template: article.jade
---

Project structure was originally based on [this angular generator](https://github.com/Swiip/generator-gulp-angular). We made some changes we thought would be better for our particular problem.

The directory structure of this template is as follows:
```
├── bower.json <- front-end library dependencies
├── gulpfile.js <- main task runner file
├── package.json <- mostly task runner dependencies
├── docs/ <- wintersmith documentation generator
├── gulp/ <- build tasks
├── src/ <- main front-end assets
│   ├── 404.html
│   ├── auth.html
│   ├── index.html <- main app dashboard page
│   ├── reg.html
│   ├── app/ <- angular application files
│   │   ├── app.js <- angular application entry point. Used for managing dependencies
│   │   ├── pages/ <- UI router pages. Pages created for demonstration purposes. Put your application js and html files here
│   │   ├── theme/ <- theme components. Contains various common widgets, panels which used across application
│   ├── assets/ <- static files (images, fonts etc.)
│   ├── sass/ <- sass styles
│   │   ├── app/ <- application styles. Used mostly for demonstration purposes. Put your app styles here.
│   │   ├── theme/ <- theme styles. Used to customize bootstrap and other common components used in tempate.
```

In our template we tried to separate theme layer and presentation layer. We believe most of other templates have them combined. That's why when you start developing using them, it gets very hard for you to remove things you don't need. Though we understand that our structure is not ideal, but we're aiming to make it as good as possible.
134 changes: 0 additions & 134 deletions docs/contents/articles/another-test/index.md

This file was deleted.

Loading

0 comments on commit de12e97

Please sign in to comment.