HOMEWORKS FRAMEWORK
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!
Notice & Warnings
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.
Getting Started
Installation
Using CDN (Quick use)
- Insert following code in your
headelement.
Install using Git
- Type the following command on the directory that you want.
$ git clone git@github.com:IGAWorksDev/homeworks.git- If you want to use
HOMEWORKSto submodule of Git, Type the command like below.
$ git submodule add git@github.com:IGAWorksDev/homeworks.git /path/of/homeworksInstall using NPM
- Just type the command as follows.
$ npm install homeworks- Drink some tee ☕️ , Yay!
Install using Bower
- Just type the command as follows.
$ bower install homeworks- Play Overwatch on the sly 😒, Yay!
Install using Yarn
- Just type the command as follows.
$ yarn add homeworks- 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
headtag of your html file.
Update the latest version
- Using Git
$ git pull origin master- Using NPM
$ npm upgrade homeworks --save- Using Bower
$ bower update homeworks --save- Using Yarn
$ yarn upgrade homeworks --saveUsing HomeWorks by Angular 2
Structures
─┬ HOMEWORKS (/homeworks) ├─ configs // homeworks lite-server configuration. ├─ coverage // homeworks coverage reports. ├─ wrapper // wrapper template for UMD. ├─┬ src │ ├┬ js │ │└─ homeworks.js // homeworks original script, import this! │ ├┬ css │ │└─ homeworks.css // homeworks original style, import this! │ └─ less // homeworks less file. ├─┬ dist │ ├┬ js │ │└─ homeworks.min.js // homeworks original script for distribution, import this! │ └┬ css │ └─ homeworks.min.css // homeworks original style for distribution, import this! ├─ site // homeworks documentations that generated by hexo. ├─ docs // homeworks api documentation that generated by jsdoc. ├─┬ lib // integration libraries. │ ├─ ng2-homeworks // homeworks for angular (generally called `angular2`). │ ├─ react-homeworks // homeworks for react. │ └─ vue-homeworks // homeworks for vue.js. ├─ main // homeworks documentation (old version). ├─ test // e2e and static test files. ├─ typings // type declaration files. └─ node_modules // npm module repository.Plan for next version
-
Integration
-
Angular 1: Plan within far future
-
Angular 2 (Typescript): Progress
- Libary will be sperated from this repository, So you can use Homeworks for ng2 by install another repositry.
-
React: Progress
-
Vue.js: Progress
-
-
Documentation
- Official Site: Plan within near future
- There is a plan to use hexo for make automated documention with markdown.
- Official Site: Plan within near future
-
Starter Kit
- .NET with Angular 2: Progress in private project.
-
CDN
- jsDelivr: Completed
- We sand PR for register the minified source on CDN. Check PR
- The PR is merged here.
- CDN url: https://www.jsdelivr.com/projects/homeworks
https://cdn.jsdelivr.net/homeworks/1.0.18/js/homeworks.min.jshttps://cdn.jsdelivr.net/homeworks/1.0.18/css/homeworks.min.css
- jsDelivr: Completed
-
Typings - DefinitelyTyped: Under processing
- We sand PR for register types files on CDN. Check PR
Contribution
Documentation
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.