Skip to content

DesignSupply/startify3

Repository files navigation

Startify3

Startify3はウェブサイトを作成するために必要なリソースがひととおり揃った静的コーディングの開発環境です。デザインから静的コーディングまでシンプルなウェブページや、JavaScriptライブラリのReactを使ったウェブアプリケーション制作もワンストップで、バンドルツールのwebpackを使って効率よく進めることができます。

また、デザインガイドライン付きのテンプレートと、デザインガイドラインに対応した変数やmixinなどが用意されたSassファイルが揃ったライブラリ(SCSS、SASS記法に対応)の「Startify-styles」と併用していただくことで、デザイン制作からコーディングまでのスムーズなワークフローを実現できます。

Features

Startify3で主にできることは以下になります。

  • webpackを使ったファイル編集の自動検知
  • Pugを使ったHTMLマークアップと自動整形およびページメタデータ外部ファイル読み込み
  • JSX・TSX記法を用いたテンプレートエンジンでのHTMLマークアップ
  • ページテンプレートに対応したJSON-LD構造化データの設定(Pug・JSX・TSX)
  • Sass(SCSS記法・SASS記法)のコンパイル
  • StyleLintでのCSSバリデーションチェック
  • ESLintでのTypeScriptおよびJavaScriptバリデーションチェック
  • Autoprefixerを使ったベンダープレフィックスの自動付与
  • Babelを使ったJavaScriptのトランスパイル
  • webpackを使ったTypeScriptのコンパイル(本番環境用・開発環境用)
  • Reactライブラリの使用(JavaScript・TypeScript)
  • TailwindCSSライブラリの使用(JSX・TSX)
  • ソースコードのマッピングファイルの生成
  • HTML、CSS、JavaScriptファイルの自動minify化
  • 開発用ローカルサーバーの起動とBrowsersyncでの自動リロード
  • 各種画像ファイル(jpg、png、gif、svg)の圧縮
  • 画像ファイルのバンドルとCSS内読み込み画像のBase64エンコード

Requirement

Node.js >= 16.x.x

npm >= 8.x.x

npx >= 8.x.x

Installation

Node.js環境のインストール(macOS)

1. Homebrewのインストール

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

2. nodebrewのインストール・セットアップ

$ brew install nodebrew
$ nodebrew setup
$ echo 'export PATH=$HOME/.nodebrew/current/bin:$PATH' >> ~/.bash_profile
$ source ~/.bash_profile

3. Node.jsのインストール

$ nodebrew install-binary stable

4. 各種パッケージのインストール

プロジェクトディレクトリにフォルダー内のファイル一式を入れて、package.jsonがあるディレクトリまで移動し、必要なパッケージをインストールします。

$ npm install

Usage

各種コマンド

1. 開発環境用ファイル編集の監視

$ npm run dev

2. 本番環境用ビルドファイルの作成

$ npm run build

Note

  • タイトル、ディスクリプション、OGPなどページ固有のmeta要素はPugのソースファイルのデータ変数用スクリプトファイルで指定できます。
  • 初期設定ではJavaScriptおよびTypeScriptのコンパイル出力先が同じになりますので上書きにご注意ください。
  • 初期設定ではSassのSCSS記法およびSASS記法のCSSファイル出力先が同じになりますので上書きにご注意ください。
  • 初期設定では〜IE11などのレガシーブラウザではページ表示時にアラートで警告が出るようになっています。
  • 初期設定では開発用ローカルサーバーのポート番号は2000となっています。
  • 初期設定ではバンドル画像のBase64エンコードできるファイルサイズの上限は50KBとなっています。
  • 初期設定ではHTML出力のテンプレートエンジンはPugになっています。webpack.config.jsファイル内の設定でReact(JSX・TSX)を使ったテンプレートエンジンに変更できます。

Author

Ogawa Shinya

info@designsupply-web.com

License

Startify is under MIT license.