https://github.com/pbeshai/protoweb

Web prototype scaffolding and hot-reloading server
https://github.com/pbeshai/protoweb

Last synced: about 1 month ago
JSON representation

Web prototype scaffolding and hot-reloading server

• Host: GitHub
• URL: https://github.com/pbeshai/protoweb
• Owner: pbeshai
• License: mit
• Created: 2018-02-22T03:19:59.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2018-06-26T19:12:12.000Z (over 6 years ago)
• Last Synced: 2024-10-22T11:31:06.411Z (3 months ago)
• Language: JavaScript
• Size: 111 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Protoweb

Quickly setup a web prototype and do development with hot-reloading. Transpilation with source maps via [Buble](https://buble.surge.sh/). SASS support. Uses bootstrap reset as a base. Includes D3. Includes eslint configuration and EditorConfig.

Inspired by [blockup](https://github.com/gabrielflorit/blockup) and [hot-server](https://github.com/1wheel/hot-server/).

## Installation

```

yarn global add protoweb

-- OR --

npm install -g protoweb

```

## Running

```

protoweb

```

Run in an empty directory and it will create a new project from a template.

Run in a non-empty directory and it will run a web server with hot reloading, JS transpilation and SCSS compilation.

```

Usage: protoweb 

Commands:

  protoweb new    scaffold and serve a new prototype (default if directory is

                  empty)

  protoweb serve  serve current prototype (default if directory is not empty)

Options:

  --port       The port the web server uses             [number] [default: 3000]

  --transpile  Enable javascript transpilation         [boolean] [default: true]

  --hot        Enable javascript hot reloading         [boolean] [default: true]

  --d3         Include d3 as an external script during creation

                                                       [boolean] [default: true]

  --sass       Enable sass compilation                 [boolean] [default: true]

  -h, --help   Show help                                               [boolean]

  --version    Show version number                                     [boolean]

```

### Sample Usage

*In an empty directory...*

**Create a project in current directory with defaults**

```

protoweb

```

**Create a project without transpilation or Sass**

```

protoweb --sass=false --transpile=false

```

*Create a project and have the initial run work without hot reloading*

```

protoweb --hot=false

```

*After creating your initial prototype...*

**Run web server without hot reloading and without tranpsilation**

```

protoweb --hot=false --transpile=false

```

**Run web server on different port**

```

protoweb --port=8080

```