No Description

Alex Gleason 692f5a7cc9 0.23.1 3 years ago
bin 5c3405f2a8 Fork Harp into Wick 3 years ago
lib 9ae8a59a32 Ignore nunjucks files on compile 3 years ago
test f9f1312799 API change: templates that output to json no longer use layout by default 3 years ago
.gitignore da94db4141 inital commit 7 years ago
.npmignore 95ffe76840 adds CONTRIBUTING.md file 5 years ago
.travis.yml 4d96e30879 Updates CI targets 4 years ago
CONTRIBUTING.md 1320901629 Fixed some typos in CONTRIBUTING.md 5 years ago
README.md 5c3405f2a8 Fork Harp into Wick 3 years ago
appveyor.yml 4d96e30879 Updates CI targets 4 years ago
package.json 692f5a7cc9 0.23.1 3 years ago

README.md

Wick

Wick is a fork of Harp with Nunjucks support. This project may change dramatically in the future, so use it at your own risk.

zero-configuration web server with built in pre-processing

What is Wick?

Wick is a static web server that also serves Jade, Markdown, EJS, Nunjucks, Less, Stylus, Sass, and CoffeeScript as HTML, CSS, and JavaScript without any configuration. It supports the beloved layout/partial paradigm and it has flexible metadata and global objects for traversing the file system and injecting custom data into templates. Optionally, Harp can also compile your project down to static assets for hosting behind any valid HTTP server.

Why?

Pre-compilers are becoming extremely powerful and shipping front-ends as static assets has many upsides. It's simple, it's easy to maintain, it's low risk, easy to scale, and requires low cognitive overhead. I wanted a lightweight web server that was powerful enough for me to abandon web frameworks for dead simple front-end publishing.

Features

  • easy installation, easy to use
  • fast and lightweight
  • robust (clean urls, intelligent path redirects)
  • built in pre-processing
  • first-class layout and partial support
  • built in LRU caching in production mode
  • can export assets to HTML/CSS/JS
  • does not require a build steps or grunt task
  • fun to use

Supported Pre-Processors

Language Superset Whitespace Sensitive
HTML EJS, Nunjucks Jade, Markdown
CSS LESS, Sass (SCSS) Stylus, Sass
JavaScript (TBD) CoffeeScript

Resources

Harp is authored and maintained by @sintaxi. Made for the @HarpPlatform.

Wick is maintained by Candlewaster.


Installation

sudo npm install -g wick

Quick Start

Creating a new Wick application is a breeze...

wick init myproj
wick server myproj

Your Wick application is now running at [http://localhost:9000]()


Documentation

Wick can be used as a library or as a command line utility.

CLI Usage

Usage: wick [command] [options]

Commands:

  init [path]                 initalize new wick application (defaults to current directory)
  server [path] [options]     start wick server
  compile [path] [options]    compile project to static assets
  multihost [path] [options]  start wick server to host directory of wick apps

Options:

  -h, --help     output usage information
  -V, --version  output the version number

Start the server in root of your application by running...

wick server

You may optionally supply a port to listen on...

wick server --port 8002

Compile an application from the root of your application by running...

wick compile

You may optionally pass in a path to where you want the compiled assets to go...

wick compile --output /path/to/cordova/project/www

Lib Usage

You may also use wick as a node library for compiling or running as a server.

Serve up a wick application...

var wick = require("wick")
harp.server(projectPath [,args] [,callback])

Or compile wick application

var wick = require("wick")
harp.compile(projectPath [,outputPath] [, callback])

Or use as Connect/ExpressJS middleware

var express = require("express");
var wick = require("wick");
var app = express();
// Express 3
app.configure(function(){
  app.use(express.static(__dirname + "/public"));
  app.use(wick.mount(__dirname + "/public"));
});
// Express 4

app.use(express.static(__dirname + "/public"));
app.use(wick.mount(__dirname + "/public"));

License

Copyright © 2012–2014 Chloi Inc. All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.