# HOMEWORKS FRAMEWORK

[![Build Status](https://travis-ci.org/IGAWorksDev/homeworks.svg?branch=master)](https://travis-ci.org/IGAWorksDev/homeworks)
[![npm version](https://badge.fury.io/js/homeworks.svg)](https://badge.fury.io/js/homeworks)
[![Bower version](https://badge.fury.io/bo/homeworks.svg)](https://badge.fury.io/bo/homeworks)
[![Coverage Status](https://coveralls.io/repos/github/IGAWorksDev/homeworks/badge.svg?branch=master)](https://coveralls.io/github/IGAWorksDev/homeworks?branch=master)
[![codecov](https://codecov.io/gh/IGAWorksDev/homeworks/branch/master/graph/badge.svg?token=viTgpBkL7A)](https://codecov.io/gh/IGAWorksDev/homeworks)
<br />
[![Dependencies Status](https://david-dm.org/IGAWorksDev/homeworks.svg)](https://david-dm.org/IGAWorksDev/homeworks)
[![Dev Dependencies Status](https://david-dm.org/IGAWorksDev/homeworks/dev-status.svg)](https://david-dm.org/IGAWorksDev/homeworks?type=dev)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

![HomeWorks Framework](https://s3.ap-northeast-2.amazonaws.com/homeworks.igaworks.com/main/src/images/homeworks_cover_v2.png?v=1)

This project helps you make the front-end page in a modern and cool way.

Yes!, This project's purpose may look similar as the one of Bootstrap or Foundation framework. 
However this project has a plan more bigger than those framework. Supporting for angular directives and reactive components is also under development. We hope you enjoy this project!

----

- [**See live demo site** (http://homeworks.igaworks.com)](http://homeworks.igaworks.com).
- [See Github of this project](https://www.github.com/IGAWorksDev/homeworks).

----

## Notice & Warnings

```plaintext
This project is still under development.
Of course, There are many features available in the current version, And you can use it!
But also as many issues can be found.
```

> If you get an error, please leave an issue [here](https://github.com/IGAWorksDev/homeworks/issues).

----

## Getting Started

- [Developer Docs (Korean)](https://kennethanceyer.gitbooks.io/homeworks-framework-wiki/content/index.html)
- [Official Site (Korean)](http://homeworks.igaworks.com/main/docs/index.html)

----

## Installation

### Using CDN (Quick use)

- Insert following code in your `head` element.

```html
<script src="https://cdn.jsdelivr.net/homeworks/1.0.16/js/homeworks.min.js"></script>
<link rel="stylesheet" href="https://cdn.jsdelivr.net/homeworks/1.0.16/css/homeworks.min.css" />
```

### Install using Git

1. Type the following command on the directory that you want.

 ```bash
$ git clone git@github.com:IGAWorksDev/homeworks.git
```

2. If you want to use `HOMEWORKS` to submodule of Git, Type the command like below.

 ```bash
$ git submodule add git@github.com:IGAWorksDev/homeworks.git /path/of/homeworks
```

----

### Install using NPM

1. Just type the command as follows.

 ```bash
$ npm install homeworks
```

2. Drink some tee :coffee: , Yay!

----

### Install using Bower

1. Just type the command as follows.

 ```bash
$ bower install homeworks
```

2. Play Overwatch on the sly :unamused:, Yay!

----

### Install using Yarn

1. Just type the command as follows.

 ```bash
$ yarn install homeworks
```

2. Now postpone work to tomorrow and watch YouTube :arrow_forward:, Yay!

----

### Install from release zip file.

> Check [HOMEWORKS Release](https://github.com/IGAWorksDev/homeworks/releases)
>
> Download the file that you want, And unzip it.

----

## Quick Start

- Run homeworks on your browser by using NPM

 ```bash
$ npm start
```

- Add this spinnet in `head` tag of your html file.

```html
<script type="text/javascript" src="homeworks/dist/js/homeworks.min.js"></script>
<link type="text/css" href="homeworks/dist/css/homeworks.min.css" />
```

----

### Update the latest version

- **Using Git**

 ```bash
$ git pull origin master
```

- **Using NPM**

 ```bash
$ npm upgrade homeworks --save
```

- **Using Bower**

 ```bash
$ bower update homeworks --save
```

- **Using Yarn**

 ```bash
$ yarn upgrade homeworks --save
```

----

## Using HomeWorks by Angular 2

- [See quick guide](https://github.com/IGAWorksDev/ng2-homeworks)

----
 
## Structures

- [JAVASCRIPT](https://kennethanceyer.gitbooks.io/homeworks-framework-wiki/content/JAVASCRIPT/) 
- [STYLE](https://kennethanceyer.gitbooks.io/homeworks-framework-wiki/content/STYLE/)

----

```html
  ─┬ HOMEWORKS (/homeworks)
   │
   ├─┬ src
   │ │ 
   │ ├┬ js
   │ │└─ homeworks.js       <!-- Original script file. -->
   │ └┬ css
   │  └─ homeworks.css      <!-- Original style sheet file. -->
   │
   ├─┬ dist
   │ │ 
   │ ├┬ js
   │ │└─ homeworks.min.js   <!-- Distributed script file. -->
   │ └┬ css
   │  └─ homeworks.min.css  <!-- Distributed style sheet file. -->
   │
   ├─ docs                  <!-- HTML documentation of homeworks. -->
   │
   ├─┬ lib                  <!-- Integration/Supporting file. -->
   │ │
   │ └─ ng2-homeworks       <!-- The git submodule for supporting to angular2 -->
   │
   ├─ main                  <!-- API reference docs for developer. -->
   │
   ├─ test                  <!-- The scripts for browse testing. -->
   │
   └─ typings               <!-- Declaration of Typescript typing for Angular -->
```

----

## Plan for next version

- Integration

  - Angular 1: Plan within far future
  - [Angular 2 (Typescript)](https://github.com/IGAWorksDev/ng2-homeworks): Progress 
 
    - Libary will be sperated from this repository, So you can use Homeworks for ng2 by install another repositry. 
  
  - ReactJS: Plan within near future 
 
- Documentation

  - Official Site: Plan within near future 
 
    - There is a plan to use [hexo](https://hexo.io) for make automated documention with markdown.
    
- Starter Kit

  - [.NET with Angular 2](https://github.com/IGAWorksDev/angular2-starterkit): Progress in private project.
  
- CDN

  - jsDelivr: Completed
  
    - We sand PR for register the minified source on CDN. [Check a PR](https://github.com/jsdelivr/jsdelivr/pull/17293)
    - The PR is merged [here](https://github.com/jsdelivr/jsdelivr/commit/74f35fe41c9a2806e1bc9fe9cb5be20f0f8069a0).
    - CDN url:
    
    ```plaintext
        https://cdn.jsdelivr.net/homeworks/1.0.16/js/homeworks.min.js
        https://cdn.jsdelivr.net/homeworks/1.0.16/css/homeworks.min.css
    ```

----

## Contribution

### Documentation
 
> This project uses [JSDoc](http://usejsdoc.org/) to provide a reference document.
>
> If you will contribute in the component development,
>
> You can use the JSDoc comment rules to create a reference document.
