Public | Automated Build

Last pushed: 2 years ago
Short Description
Short description is empty for this repo.
Full Description

fluo-frontend-devserver

Fluo-frontend is a development suite for creating static websites. It's designed to generate websites with simple file system based routing you can find in all web servers out of the box. The artefacts are then supposed to be hosted on "dumb" servers without any possibility to run CGI-like scripts.

This application provides a basic web server which is especially suited for development environments. It won't work in production because it's designed to serve only one user at a time.

This devserver compiles only the requested page using the fluo-frontend-core library. Please see the docs of fluo-frontend-core for more information.

Running using node.js

Install

  1. Install node.js.
  2. Checkout the source.
  3. Run npm install.
  4. Use ./bin/run --config FILE to run the server

After running this exec the server will listen on the configured ip and port for requests and use fluo-frontend-core for assembling the project.

Running with docker

Install docker

Use the docker image to run the container inside your project. Mount the project directory to /mnt/app. The config is expected to be at /mnt/app/config.js

docker run dypsilon/fluo-frontend-devserver -v /path/to/project:/mnt/app -p 8080:8080

The exposed port should match the configured port (see below).

Running with fig

Install fig

Here is a sample fig.yml for your project:

fedev:
    image: dypsilon/fluo-frontend-devserver
    ports:
        - "8080:8080"
    volumes:
        - ./frontend:/mnt/app

Most important path here is './frontend'. It's the path to the directory with the config.js file.

The exposed port should match the configured port (see below).

Configuration

The configuration is a CommonJS module with the exported object. Here is a sample:

var path = require('path');

var config = module.exports = {};

config.devServer = {
    'listen': {
        'host': '0.0.0.0',
        'port': '8080'
    }
};

The rest of the configuration is described in the fluo-frontend-core.

Docker Pull Command
Owner
dypsilon