Git Product home page Git Product logo

scalable-website-template's Introduction

Scalable Website Template

拡張しやすいWebサイトのためのテンプレートです。
ページ単位でのデザインをしない、コンポーネントベースでの制作を想定しています。

確認環境

以下の環境で動作の確認をしています。

  • OS X 10.11.5(El Capitan)
  • Node.js 4.2.4
  • Yarn 0.21.3

始め方

Yarnをインストールしていない場合はグローバルにインストールしてください。

npm install -g yarn

詳しくは公式ドキュメントを参照してください。

開発に必要なパッケージなどは以下のコマンドですべてインストールされます。クローン、またはダウンロードをしたあとに実行してください。

yarn install

ファイル構成

開発はdevelopディレクトリでおこない、テスト用の一時ファイルはtestディレクトリに出力、公開用のファイルはhtdocsディレクトリに出力されます。
publicディレクトリは処理は必要ないけれど、ファビコンのようなサイト制作に必要なファイルを置きます。

root/
├── README.md
├── aigis/
├── develop/
│   ├── _data/
│   │   └── site.json
│   ├── _include/
│   │   ├── _meta.pug
│   │   ├── _script.pug
│   │   └── _layout.pug
│   ├── assets/
│   │   ├── css/
│   │   │   ├── base/
│   │   │   ├── atoms/
│   │   │   ├── molecules/
│   │   │   ├── organisms/
│   │   │   ├── templates/
│   │   │   ├── pages/
│   │   │   ├── styleguide/
│   │   │   └── common.scss
│   │   ├── icon/
│   │   │   └── template/
│   │   ├── img/
│   │   └── js/
│   │       ├── common/
│   │       ├── jquery-2.2.0.min.js
│   │       └── module/
│   └── index.pug
├── gulpfile.js
├── package.json
├── yarn.lock
└── public/

開発用タスク

以下のコマンドを実行すると、開発に必要なGulpのタスクがすべて実行されます。

yarn start

以下のような処理がおこなわれます。

  • PugをHTMLにコンパイル
  • SassをCSSにコンパイル
  • JSを連結・圧縮
  • アイコンフォントの生成
  • ローカルサーバーを立ち上げて動作の確認
  • スタイルガイドの生成

詳しい説明はyarn startを実行後、/styleguideにアクセスして確認してください。

以下のコマンドを実行すると、本番公開用のファイルが出力されます。

yarn run release

対象ブラウザ

デフォルトでは下記のようなブラウザを対象にしています。

  • IE9以降
  • iOS8以降
  • Android4.4以降
  • その他ブラウザは最新版

scalable-website-template's People

Contributors

manabuyasuda avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

scalable-website-template's Issues

Stylelintの導入

リントを使ってCSSのコーディングルールを統一化する。

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.