Publish HTML quickly.
Clone or download
Latest commit 54e7055 Dec 14, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
keys Add backend ability to save/get a house Oct 11, 2015
less Move LESS files out of `css` to `less` directory Jan 5, 2018
main Move import path to writeas/htmlhouse Oct 25, 2015
static Move LESS files out of `css` to `less` directory Jan 5, 2018
templates Read API data in editor from top-level object Mar 12, 2018
.gitignore Add package build script May 18, 2017
CONTRIBUTING.md Add contributing guidelines Jan 5, 2018
INSTALL Add install instructions May 19, 2017
LICENSE Add MIT license Dec 14, 2018
README.md Support blacklist for terms that prevent a public post Mar 12, 2018
app.go Add public houses endpoint Mar 8, 2016
build.sh Add install instructions May 19, 2017
config.go Support blacklist for terms that prevent a public post Mar 12, 2018
construction.go Return 404 for stats on nonexistent houses Mar 18, 2018
database.go Add backend ability to save/get a house Oct 11, 2015
filter.go Automatically pass public filter when no blacklist configured Mar 12, 2018
house.go Add backend ability to save/get a house Oct 11, 2015
init.sql Support posting new public houses to Twitter Jan 22, 2016
keys.sh Prevent running keys.sh with no params Oct 25, 2015
makefile Move LESS files out of `css` to `less` directory Jan 5, 2018
models.go Make thumbnails host configurable Jan 20, 2018
session.go Parse JWT keys correctly Mar 12, 2018
templates.go Add Browse page Jan 2, 2016
twitter.go Skip tweeting pages with "HTMLhouse" title Jan 22, 2016

README.md

HTMLhouse

Publish HTML quickly.

HTMLhouse screenshot

HTMLhouse uses ACE editor for modifying HTML and shows a live preview of what you've created in an iframe alongside the source code.

No user signup is required -- authorization to modify an individual published page is saved on the creator's device in local storage as an ID and JWT generated by the server.

It is also available as a Chrome extension and browsable on Android.

#writeas on freenode Public Slack discussion

Development

Requirements

  • Go
  • Node.js
  • MySQL

Setup

  1. Clone the repo
  2. Run go get -d to get necessary dependencies
  3. Run make install to install LESS compiler locally and generate the CSS files
  4. Run the queries in init.sql to set up the database
  5. Optional. Run ./keys.sh prod to create a new keypair

Running the server

  • Run go run main/main.go in the top level directory, optionally by creating a simple run script
#!/bin/bash

DB_USER=dbuser DB_PASSWORD=pass DB_DB=htmlhouse PRIVATE_KEY=keys/dev PUBLIC_KEY=keys/dev.pub go run main/main.go

Environment Variables

Variable What it is Default value
DB_USER Database user None. Required
DB_PASSWORD Database password None. Required
DB_DB Database name None. Required
DB_HOST Database host localhost
PRIVATE_KEY Generated private key None. Required
PUBLIC_KEY Generated public key None. Required
PORT Port to run app on 8080
STATIC_DIR Relative dir where static files are stored static
AUTO_APPROVE Automatically approves public posts false
PREVIEWS_HOST Fully-qualified URL (without trailing slash) of screenshot server None.
ADMIN_PASS Password to perform admin functions via API uhoh
BROWSE_ITEMS Number of items to show on Browse page 10
BLACKLIST_TERMS Comma-separated list of terms to prevent a post from being made public None.
TWITTER_KEY Twitter consumer key notreal
TWITTER_SECRET Twitter consumer secret notreal
TWITTER_TOKEN Twitter access token of the posting Twitter account notreal
TWITTER_TOKEN_SECRET Twitter access token secret of the posting Twitter account notreal

Notes

Changing CSS. Run make after all changes to update the stylesheets.

When you don't need to reload the app. When you make changes to any files in static/ you can simply refresh the resource without restarting the app.

When to reload the app. If you change any of the templates in templates/ or any .go file, you'll need to re-run the app.