Fedor

zero-configuration web server with built in pre-processing

http://fedor.io/

What is Fedor?

Fedor is a static web server that also serves Jade, Markdown, EJS, 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, Fedor 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, fast and lightweight
• robust (clean urls, intelligent path redirects)
• built in pre-processing (es6, coffeescript, sass, less, stylue, markdown, browserify additionally)
• 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 | Jade, Markdown | CSS | LESS, Sass (SCSS) | Stylus, Sass | JavaScript | (TBD) | CoffeeScript

Installation

sudo npm install -g fedor

Quick Start

Creating a new fedor application is a breeze...

fedor init myproj
fedor server myproj

Your Fedor application is now running at http://localhost:3000

Documentation

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

CLI Usage

Usage: fedor [command] [options]

Commands:

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

Options:

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

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

fedor server

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

fedor server --port 8002

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

fedor compile

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

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

Lib Usage

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

Serve up a fedor application...

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

Or compile fedor application

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

Or use as Connect/ExpressJS middleware

var express = require("express");
var fedor = require("fedor");
var app = express();

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