Get Started
Methodically build complex, responsive web projects
Wee bundles many of the components needed to build modern websites and apps. True to its name, Wee also maintains a small footprint. Get started with these quick steps:
- Install the latest stable version of Node.js
- Run
npm install -g wee-cli
to globally install the Wee CLI - Download Wee from GitHub or clone it using using
git clone git://github.com/weepower/wee.git
- Navigate to your project in the command line and run
npm install
to install Wee core
Features
Mobile-first CSS framework with configurable reset and mixin library ~ 3KB gzipped
- Central configuration for style normalization
- Feature toggling to minimize build size
- Structured breakpoints to organize responsive logic
- Print styling to generate print-optimized pages
JavaScript toolset to build scalable, organized client logic ~ 14KB gzipped
- Foundation of utilities, helpers, and controller structure
- Chainable DOM traversal and manipulation with familiar API
- Animation methods to tween CSS attributes and properties
- Touch support for directional swipe events
- Routing library to flexibly associate endpoints to actions
- Event handling to bind actions to elements
- Data loading for Ajax and JSON interaction
- HTML5 history helper to create highly dynamic experiences
- Template rendering to parse complex data structures
- Data binding to sync data models to the DOM
- Resource loading for JavaScript, CSS, and images
- Breakpoint watching for efficient media query callbacks
JSON-configured build process to compile, optimize, and minify your project
- Built-in server for local static development
- Live reloading of assets and markup
- Ghost mode to mirror actions across multiple browsers
- Static site generator perfect for living style guides
- Sourcemap output to line match unminified JavaScript
- Validation of JavaScript against JSCS and JSHint rules
Structured foundation of markup, icons, and supporting files
Prerequisites
There are a couple tools you'll need to build a project
The first dependency is Node.js. If it’s already installed run node -v
to check the version and compare it against the latest stable release. If you don’t get a response or have an outdated version, download and install the latest release. Node also includes npm (Node Package Manager) which is used to install Wee’s dependencies.
Next install the Wee CLI (Command Line Interface) from npm by running npm install -g wee-cli
. This allows you to build your project and execute commands.
Setup
- Download the latest release or
- Clone the repository from
git clone git://github.com/weepower/wee.git
Next, navigate to your project directory in command line by running cd path/to/your/project
or typing cd
with a space and dragging your project folder into the command line window. Now run npm install
to install the dependencies and check out the build docs to launch your project.
Compatibility
Wee officially supports the following minimum browser versions
Chrome | Edge | Firefox | IE | Safari |
---|---|---|---|---|
30 | 20 | 29 | 9 | 7.1 |