hyamamoto / web-starter-kit.dart

"Web Starter Kit　for Dart" (wsk), a asset/template pack for Dart pub repository.

Web Starter Kit for Dart

( wsk in Pub repository )

version 0.5.2 (11/14/2014)

Overview

Web Starter Kit for Dart ( wsk ) is a asset/template/util pack for Dart pub repository. It's made for kick-starting a Dart project for Web Starter Kit without a hussle.

Quick Start

Within the Dart Editor...

1. Create a new empty Dart project.
2. Open pubspec.yaml and add wsk package. Save it.
3. Select Tools > Pub Get from the application menu.
4. Copy 2 directories inside {project_dir}/packages/wsk/templates to your project root. This can be done by a simple drag & drop with a Ctrl or Option key pressed.
5. Right-click {project_dir}/web/index.html. Select Run in Dartium.

Then, you'll see the working web page on your browser. ( Live Demo )

Features

What wsk package provides...

• Pre-built static resources from Web Starter Kit
  • CSS, Fonts, and Images
  • Sass source files
• A Dart project template
• Dart utility methods
  • Routing
  • Transformer for release build (URL rewriting)

What wsk package does not provides...

• Web application framework
  • Utility methods are provided, But they're always for optional use.
• UI components framework
  • Won't be here to keep this package light-weight. Use polymer.dart if you prefer a complete UI framework.
• Sass auto-compiling setup
  • Sass, I think, requires some effort to run which defeats the purpose of this package being a "Starter Kit".

Package structure

    packages
    └── wsk
        ├── assets
        │   ├── fonts
        │   ├── images
        │   ├── scripts
        │   └── styles
        │       ├── components.css
        │       ├── components.min.css
        │       ├── main.css
        │       └── main.min.css
        ├── sass
        │   ├── components
        │   │   └── components.scss
        │   └── main.scss
        ├── templates
        │   ├── tests
        │   └── web
        │       ├── index.dart
        │       ├── index.html
        │       ├── styleguide.dart
        │       └── styleguide.html
        ├── routing_utils.dart
        ├── transformer.dart
        └── wsk.dart

wsk/assets directory

wsk/assets directory includes precompiled static resources which might be referenced by web pages. In Dart project, this directory can be referenced as packages/ask/assets from your HTML document. you can change the path on release build by adding transformers section inside pubspec.yaml.

You can include the Web Starter Kit's stylesheets once you have added this package as a dependency to your application:

    <!-- include the stylesheets -->
    <link rel="stylesheet" href="packages/wsk/assets/styles/main.css">
    

wsk/sass directory

wsk/sass directory includes source files for wsk/assets/styles/main.css and wsk/assets/styles/components/components.css. You might want to copy this directory to your project directory if you want to modify Sass files to opt out some of the style difinitions.

wsk/templates directory

wsk/templates directory includes a web application template for your project. You just copy all the directories inside it to your project root directory.

• index.html (index.html, index.dart)
  Your main web application.
• styleguide.html (styleguide.html, styleguide.dart)
  A sample web application containing all the HTML snippet for Web Starter Kit.

Transformer

wsk package has a transformer to modify an asset path for release build. This way asset files can be placed on any servers.

Read doc/transformer.md for more detail.

Change Logs

0.5.2 (11/14/2014)

• Renamed apple-touch-icon-precomposed.png to apple-touch-icon.png.
• Added meta-theme-color to index.html

0.5.1+1

• Initial version.

License

web_starter_kit.dart (wsk) is released under the Apache 2.0 License by Hiroshi Yamamoto [e-mail]

Learn more

• Web Starter Kit for Dart on Pub repository
• Web Starter Kit for Dart Live Demo
• Web Starter Kit Documentation on Google Developers
• Web Starter Kit on Github
• Sass
• Sass package on Pub reopsitory