HOMEWORKS FRAMEWORK

This project helps develop the front-end in a modern and cool way.

Yes!, This project may look similar to the purpose of Bootstrap or Foundation framework. But this project has a plan more bigger than one fundamentally. Support for angular directives and reactive components is also under development. We hope you enjoy this project!

---

Notice & Warnings

This project is under development yet.
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.

---

Getting Started

• Developer Docs (Korean)
• Official Site (Korean)

---

Installation

Install using Git

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

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

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

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

---

Install using NPM

1. Just type the command as follows.

$ npm install homeworks

2. Drink some tee ☕ , Yay!

---

Install using Bower

1. Just type the command as follows.

$ bower install homeworks

2. Play Overwatch on the sly 😒, Yay!

---

Install using Yarn

1. Just type the command as follows.

$ yarn install homeworks

2. Now postpone work to tomorrow and watch YouTube ▶️, Yay!

---

Install from release zip file.

Check HOMEWORKS Release

Download the file that you want, And unzip it.

---

Quick Start

• Run homeworks on your browser by using NPM

$ npm start

• Add this spinnet in head tag of your html file.

<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

$ git pull origin master

• Using NPM

$ npm upgrade homeworks

• Using Bower

$ bower update homeworks

• Using Yarn

$ yarn upgrade homeworks

---

Structures

• JAVASCRIPT
• STYLE

---

  ─┬ 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. -->
   │
   ├─ main                   <!-- API reference docs for developer. -->
   │
   ├─ test                   <!-- The scripts for browse testing. -->
   │
   ├─ typings                <!-- Declaration of Typescript typing for Angular -->
   │
   └─┬ vender
     │
     └┬ js
      ├─ jquery-1.12.2.min.js
      └─ jquery-3.1.1.min.js

---

Contribution

Docs

This project uses JSDoc 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.

Flow

Check this description