Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.23 KB

DEPLOYING_LOCALLY.md

File metadata and controls

43 lines (30 loc) · 1.23 KB
Raw

If you want to try franchise out, there's an online version you try right now right here.

If you're interested in contributing, there are instructions for running franchise in development mode in the readme.

Otherwise...

Deploying Locally

  1. If you don't have npm or yarn, install yarn.

  2. Open up a terminal and run

    git clone --depth 1 https://github.com/HVF/franchise.git

  3. cd into the project directory

    cd franchise

  4. Install the project dependencies

    yarn install

    (you can also run npm install)

  5. Build franchise to static files

    yarn build

    This command makes a folder named /bundle containing an index.html file which runs franchise when you open it in a browser.

  6. Serve the static files

    Use the http server of your choice to serve the contents of the /bundle directory. Using python, you might write:

    cd bundle
python -m SimpleHTTPServer

  7. (optional) Email us at sql@hvflabs.com if you're doing something interesting with franchise!